aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNoam Postavsky2018-02-13 22:10:03 -0500
committerNoam Postavsky2018-02-16 22:13:34 -0500
commit593bbdaf0b890924e9d10918ba6de206bddc2eb6 (patch)
tree7e6be33c807229309a3ca5c29a5e86fc492422e8
parentbd4cc8d5647627b11db9be4483fc6a331b961d4f (diff)
downloademacs-593bbdaf0b890924e9d10918ba6de206bddc2eb6.tar.gz
emacs-593bbdaf0b890924e9d10918ba6de206bddc2eb6.zip
Document comment-fill-column in the manual (Bug#11636)
* doc/emacs/programs.texi (Comment Commands) (Options for Comments): Mention comment-fill-column.
-rw-r--r--doc/emacs/programs.texi25
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi
index 4d515f29b6c..bafe5cc87be 100644
--- a/doc/emacs/programs.texi
+++ b/doc/emacs/programs.texi
@@ -999,13 +999,13 @@ the line is blank (i.e., empty or containing only whitespace
999characters), the comment is indented to the same position where 999characters), the comment is indented to the same position where
1000@kbd{@key{TAB}} would indent to (@pxref{Basic Indent}). If the line 1000@kbd{@key{TAB}} would indent to (@pxref{Basic Indent}). If the line
1001is non-blank, the comment is placed after the last non-whitespace 1001is non-blank, the comment is placed after the last non-whitespace
1002character on the line; normally, Emacs tries putting it at the column 1002character on the line. Emacs tries to fit the comment between the
1003specified by the variable @code{comment-column} (@pxref{Options for 1003columns specified by the variables @code{comment-column} and
1004Comments}), but if the line already extends past that column, it puts 1004@code{comment-fill-column} (@pxref{Options for Comments}), if
1005the comment at some suitable position, usually separated from the 1005possible. Otherwise, it will choose some other suitable position,
1006non-comment text by at least one space. In each case, Emacs places 1006usually separated from the non-comment text by at least one space. In
1007point after the comment's starting delimiter, so that you can start 1007each case, Emacs places point after the comment's starting delimiter,
1008typing the comment text right away. 1008so that you can start typing the comment text right away.
1009 1009
1010 You can also use @kbd{M-;} to align an existing comment. If a line 1010 You can also use @kbd{M-;} to align an existing comment. If a line
1011already contains the comment-start string, @kbd{M-;} realigns it to 1011already 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.
1098@subsection Options Controlling Comments 1098@subsection Options Controlling Comments
1099 1099
1100@vindex comment-column 1100@vindex comment-column
1101@vindex comment-fill-column
1101@kindex C-x ; 1102@kindex C-x ;
1102@findex comment-set-column 1103@findex comment-set-column
1103 As mentioned in @ref{Comment Commands}, when the @kbd{M-j} command 1104 As mentioned in @ref{Comment Commands}, when the @kbd{M-j} command
1104adds a comment to a line, it tries to place the comment at the column 1105adds a comment to a line, it tries to place the comment between the
1105specified by the buffer-local variable @code{comment-column}. You can 1106columns specified by the buffer-local variables @code{comment-column}
1106set either the local value or the default value of this buffer-local 1107and @code{comment-fill-column} (or if that is @code{nil}, then the
1107variable in the usual way (@pxref{Locals}). Alternatively, you can 1108value of @code{fill-column}, @pxref{Fill Commands}). You can set
1109either the local value or the default value of these buffer-local
1110variables in the usual way (@pxref{Locals}). Alternatively, you can
1108type @kbd{C-x ;} (@code{comment-set-column}) to set the value of 1111type @kbd{C-x ;} (@code{comment-set-column}) to set the value of
1109@code{comment-column} in the current buffer to the column where point 1112@code{comment-column} in the current buffer to the column where point
1110is currently located. @kbd{C-u C-x ;} sets the comment column to 1113is currently located. @kbd{C-u C-x ;} sets the comment column to