procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document comment-fill-column in the manual (Bug#11636)

Browse source 
* doc/emacs/programs.texi (Comment Commands)
(Options for Comments): Mention comment-fill-column.
This commit is contained in:
Noam Postavsky 2018-02-13 22:10:03 -05:00
parent bd4cc8d564
commit 593bbdaf0b
1 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/emacs/programs.texi
View file

@ -999,13 +999,13 @@ the line is blank (i.e., empty or containing only whitespace
characters), the comment is indented to the same position where characters), the comment is indented to the same position where
@kbd{@key{TAB}} would indent to (@pxref{Basic Indent}). If the line @kbd{@key{TAB}} would indent to (@pxref{Basic Indent}). If the line
is non-blank, the comment is placed after the last non-whitespace is non-blank, the comment is placed after the last non-whitespace
character on the line; normally, Emacs tries putting it at the column character on the line. Emacs tries to fit the comment between the
specified by the variable @code{comment-column} (@pxref{Options for columns specified by the variables @code{comment-column} and
Comments}), but if the line already extends past that column, it puts @code{comment-fill-column} (@pxref{Options for Comments}), if
the comment at some suitable position, usually separated from the possible. Otherwise, it will choose some other suitable position,
non-comment text by at least one space. In each case, Emacs places usually separated from the non-comment text by at least one space. In
point after the comment's starting delimiter, so that you can start each case, Emacs places point after the comment's starting delimiter,
typing the comment text right away. so that you can start typing the comment text right away.
You can also use @kbd{M-;} to align an existing comment. If a line You can also use @kbd{M-;} to align an existing comment. If a line
already contains the comment-start string, @kbd{M-;} realigns it to already contains the comment-start string, @kbd{M-;} realigns it to
@ -1098,13 +1098,16 @@ comment. Enable the @code{comment-close-slash} clean-up for this.
@subsection Options Controlling Comments @subsection Options Controlling Comments
@vindex comment-column @vindex comment-column
@vindex comment-fill-column
@kindex C-x ; @kindex C-x ;
@findex comment-set-column @findex comment-set-column
As mentioned in @ref{Comment Commands}, when the @kbd{M-j} command As mentioned in @ref{Comment Commands}, when the @kbd{M-j} command
adds a comment to a line, it tries to place the comment at the column adds a comment to a line, it tries to place the comment between the
specified by the buffer-local variable @code{comment-column}. You can columns specified by the buffer-local variables @code{comment-column}
set either the local value or the default value of this buffer-local and @code{comment-fill-column} (or if that is @code{nil}, then the
variable in the usual way (@pxref{Locals}). Alternatively, you can value of @code{fill-column}, @pxref{Fill Commands}). You can set
either the local value or the default value of these buffer-local
variables in the usual way (@pxref{Locals}). Alternatively, you can
type @kbd{C-x ;} (@code{comment-set-column}) to set the value of type @kbd{C-x ;} (@code{comment-set-column}) to set the value of
@code{comment-column} in the current buffer to the column where point @code{comment-column} in the current buffer to the column where point
is currently located. @kbd{C-u C-x ;} sets the comment column to is currently located. @kbd{C-u C-x ;} sets the comment column to