diff options
| author | Richard M. Stallman | 2005-05-14 11:20:19 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-05-14 11:20:19 +0000 |
| commit | dd77d6f4d369f5fd2ef1afa688a82faba16e00f4 (patch) | |
| tree | 62bec9c63eb2ecf195c156656b3eb842c8608f91 /lisp | |
| parent | 54005870a2197b6599734297cb2f46dbadc10558 (diff) | |
| download | emacs-dd77d6f4d369f5fd2ef1afa688a82faba16e00f4.tar.gz emacs-dd77d6f4d369f5fd2ef1afa688a82faba16e00f4.zip | |
Many doc usage fixes.
(sh-indent-after-do): Change default to match common styles.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/progmodes/sh-script.el | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index ae024e8111e..f01da859c9e 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el | |||
| @@ -1015,7 +1015,7 @@ Anything else means: whenever we have a \"good guess\" as to the value." | |||
| 1015 | :group 'sh-indentation) | 1015 | :group 'sh-indentation) |
| 1016 | 1016 | ||
| 1017 | (defcustom sh-popup-occur-buffer nil | 1017 | (defcustom sh-popup-occur-buffer nil |
| 1018 | "*Controls when `sh-learn-buffer-indent' pops the *indent* buffer. | 1018 | "*Controls when `sh-learn-buffer-indent' pops the `*indent*' buffer. |
| 1019 | If t it is always shown. If nil, it is shown only when there | 1019 | If t it is always shown. If nil, it is shown only when there |
| 1020 | are conflicts." | 1020 | are conflicts." |
| 1021 | :type '(choice | 1021 | :type '(choice |
| @@ -1044,7 +1044,7 @@ Can be set to a number, or to nil which means leave it as is." | |||
| 1044 | 1044 | ||
| 1045 | (defcustom sh-basic-offset 4 | 1045 | (defcustom sh-basic-offset 4 |
| 1046 | "*The default indentation increment. | 1046 | "*The default indentation increment. |
| 1047 | This value is used for the + and - symbols in an indentation variable." | 1047 | This value is used for the `+' and `-' symbols in an indentation variable." |
| 1048 | :type 'integer | 1048 | :type 'integer |
| 1049 | :group 'sh-indentation) | 1049 | :group 'sh-indentation) |
| 1050 | 1050 | ||
| @@ -1088,7 +1088,7 @@ a number means align to that column, e.g. 0 means fist column." | |||
| 1088 | :menu-tag "/ Indent left half sh-basic-offset"))) | 1088 | :menu-tag "/ Indent left half sh-basic-offset"))) |
| 1089 | 1089 | ||
| 1090 | (defcustom sh-indent-for-else 0 | 1090 | (defcustom sh-indent-for-else 0 |
| 1091 | "*How much to indent an else relative to an if. Usually 0." | 1091 | "*How much to indent an `else' relative to its `if'. Usually 0." |
| 1092 | :type `(choice | 1092 | :type `(choice |
| 1093 | (integer :menu-tag "A number (positive=>indent right)" | 1093 | (integer :menu-tag "A number (positive=>indent right)" |
| 1094 | :tag "A number") | 1094 | :tag "A number") |
| @@ -1104,75 +1104,75 @@ a number means align to that column, e.g. 0 means fist column." | |||
| 1104 | sh-symbol-list)) | 1104 | sh-symbol-list)) |
| 1105 | 1105 | ||
| 1106 | (defcustom sh-indent-for-fi 0 | 1106 | (defcustom sh-indent-for-fi 0 |
| 1107 | "*How much to indent a fi relative to an if. Usually 0." | 1107 | "*How much to indent a `fi' relative to its `if'. Usually 0." |
| 1108 | :type `(choice ,@ sh-number-or-symbol-list ) | 1108 | :type `(choice ,@ sh-number-or-symbol-list ) |
| 1109 | :group 'sh-indentation) | 1109 | :group 'sh-indentation) |
| 1110 | 1110 | ||
| 1111 | (defcustom sh-indent-for-done '0 | 1111 | (defcustom sh-indent-for-done 0 |
| 1112 | "*How much to indent a done relative to its matching stmt. Usually 0." | 1112 | "*How much to indent a `done' relative to its matching stmt. Usually 0." |
| 1113 | :type `(choice ,@ sh-number-or-symbol-list ) | 1113 | :type `(choice ,@ sh-number-or-symbol-list ) |
| 1114 | :group 'sh-indentation) | 1114 | :group 'sh-indentation) |
| 1115 | 1115 | ||
| 1116 | (defcustom sh-indent-after-else '+ | 1116 | (defcustom sh-indent-after-else '+ |
| 1117 | "*How much to indent a statement after an else statement." | 1117 | "*How much to indent a statement after an `else' statement." |
| 1118 | :type `(choice ,@ sh-number-or-symbol-list ) | 1118 | :type `(choice ,@ sh-number-or-symbol-list ) |
| 1119 | :group 'sh-indentation) | 1119 | :group 'sh-indentation) |
| 1120 | 1120 | ||
| 1121 | (defcustom sh-indent-after-if '+ | 1121 | (defcustom sh-indent-after-if '+ |
| 1122 | "*How much to indent a statement after an if statement. | 1122 | "*How much to indent a statement after an `if' statement. |
| 1123 | This includes lines after else and elif statements, too, but | 1123 | This includes lines after `else' and `elif' statements, too, but |
| 1124 | does not affect then else elif or fi statements themselves." | 1124 | does not affect the `else', `elif' or `fi' statements themselves." |
| 1125 | :type `(choice ,@ sh-number-or-symbol-list ) | 1125 | :type `(choice ,@ sh-number-or-symbol-list ) |
| 1126 | :group 'sh-indentation) | 1126 | :group 'sh-indentation) |
| 1127 | 1127 | ||
| 1128 | (defcustom sh-indent-for-then 0 | 1128 | (defcustom sh-indent-for-then 0 |
| 1129 | "*How much to indent a then relative to an if." | 1129 | "*How much to indent a `then' relative to its `if'." |
| 1130 | :type `(choice ,@ sh-number-or-symbol-list ) | 1130 | :type `(choice ,@ sh-number-or-symbol-list ) |
| 1131 | :group 'sh-indentation) | 1131 | :group 'sh-indentation) |
| 1132 | 1132 | ||
| 1133 | (defcustom sh-indent-for-do 0 | 1133 | (defcustom sh-indent-for-do 0 |
| 1134 | "*How much to indent a do statement. | 1134 | "*How much to indent a `do' statement. |
| 1135 | This is relative to the statement before the do, i.e. the | 1135 | This is relative to the statement before the `do', i.e. the |
| 1136 | while until or for statement." | 1136 | `while', `until' or `for' statement." |
| 1137 | :type `(choice ,@ sh-number-or-symbol-list) | 1137 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1138 | :group 'sh-indentation) | 1138 | :group 'sh-indentation) |
| 1139 | 1139 | ||
| 1140 | (defcustom sh-indent-after-do '* | 1140 | (defcustom sh-indent-after-do '+ |
| 1141 | "*How much to indent a line after a do statement. | 1141 | "*How much to indent a line after a `do' statement. |
| 1142 | This is used when the do is the first word of the line. | 1142 | This is used when the `do' is the first word of the line. |
| 1143 | This is relative to the statement before the do, e.g. a | 1143 | This is relative to the statement before the `do', e.g. a |
| 1144 | while for repeat or select statement." | 1144 | `while', `for', `repeat' or `select' statement." |
| 1145 | :type `(choice ,@ sh-number-or-symbol-list) | 1145 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1146 | :group 'sh-indentation) | 1146 | :group 'sh-indentation) |
| 1147 | 1147 | ||
| 1148 | (defcustom sh-indent-after-loop-construct '+ | 1148 | (defcustom sh-indent-after-loop-construct '+ |
| 1149 | "*How much to indent a statement after a loop construct. | 1149 | "*How much to indent a statement after a loop construct. |
| 1150 | 1150 | ||
| 1151 | This variable is used when the keyword \"do\" is on the same line as the | 1151 | This variable is used when the keyword `do' is on the same line as the |
| 1152 | loop statement (e.g. \"until\", \"while\" or \"for\"). | 1152 | loop statement (e.g., `until', `while' or `for'). |
| 1153 | If the do is on a line by itself, then `sh-indent-after-do' is used instead." | 1153 | If the `do' is on a line by itself, then `sh-indent-after-do' is used instead." |
| 1154 | :type `(choice ,@ sh-number-or-symbol-list) | 1154 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1155 | :group 'sh-indentation) | 1155 | :group 'sh-indentation) |
| 1156 | 1156 | ||
| 1157 | 1157 | ||
| 1158 | (defcustom sh-indent-after-done 0 | 1158 | (defcustom sh-indent-after-done 0 |
| 1159 | "*How much to indent a statement after a \"done\" keyword. | 1159 | "*How much to indent a statement after a `done' keyword. |
| 1160 | Normally this is 0, which aligns the \"done\" to the matching | 1160 | Normally this is 0, which aligns the `done' to the matching |
| 1161 | looping construct line. | 1161 | looping construct line. |
| 1162 | Setting it non-zero allows you to have the \"do\" statement on a line | 1162 | Setting it non-zero allows you to have the `do' statement on a line |
| 1163 | by itself and align the done under to do." | 1163 | by itself and align the done under to do." |
| 1164 | :type `(choice ,@ sh-number-or-symbol-list) | 1164 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1165 | :group 'sh-indentation) | 1165 | :group 'sh-indentation) |
| 1166 | 1166 | ||
| 1167 | (defcustom sh-indent-for-case-label '+ | 1167 | (defcustom sh-indent-for-case-label '+ |
| 1168 | "*How much to indent a case label statement. | 1168 | "*How much to indent a case label statement. |
| 1169 | This is relative to the line containing the case statement." | 1169 | This is relative to the line containing the `case' statement." |
| 1170 | :type `(choice ,@ sh-number-or-symbol-list) | 1170 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1171 | :group 'sh-indentation) | 1171 | :group 'sh-indentation) |
| 1172 | 1172 | ||
| 1173 | (defcustom sh-indent-for-case-alt '++ | 1173 | (defcustom sh-indent-for-case-alt '++ |
| 1174 | "*How much to indent statements after the case label. | 1174 | "*How much to indent statements after the case label. |
| 1175 | This is relative to the line containing the case statement." | 1175 | This is relative to the line containing the `case' statement." |
| 1176 | :type `(choice ,@ sh-number-or-symbol-list) | 1176 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1177 | :group 'sh-indentation) | 1177 | :group 'sh-indentation) |
| 1178 | 1178 | ||
| @@ -1184,7 +1184,7 @@ This is relative to the line containing the case statement." | |||
| 1184 | 1184 | ||
| 1185 | (defcustom sh-indent-after-open '+ | 1185 | (defcustom sh-indent-after-open '+ |
| 1186 | "*How much to indent after a line with an opening parenthesis or brace. | 1186 | "*How much to indent after a line with an opening parenthesis or brace. |
| 1187 | For an open paren after a function `sh-indent-after-function' is used." | 1187 | For an open paren after a function, `sh-indent-after-function' is used." |
| 1188 | :type `(choice ,@ sh-number-or-symbol-list) | 1188 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1189 | :group 'sh-indentation) | 1189 | :group 'sh-indentation) |
| 1190 | 1190 | ||
| @@ -1196,13 +1196,13 @@ For an open paren after a function `sh-indent-after-function' is used." | |||
| 1196 | ;; These 2 are for the rc shell: | 1196 | ;; These 2 are for the rc shell: |
| 1197 | 1197 | ||
| 1198 | (defcustom sh-indent-after-switch '+ | 1198 | (defcustom sh-indent-after-switch '+ |
| 1199 | "*How much to indent a case statement relative to the switch statement. | 1199 | "*How much to indent a `case' statement relative to the `switch' statement. |
| 1200 | This is for the rc shell." | 1200 | This is for the rc shell." |
| 1201 | :type `(choice ,@ sh-number-or-symbol-list) | 1201 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1202 | :group 'sh-indentation) | 1202 | :group 'sh-indentation) |
| 1203 | 1203 | ||
| 1204 | (defcustom sh-indent-after-case '+ | 1204 | (defcustom sh-indent-after-case '+ |
| 1205 | "*How much to indent a statement relative to the case statement. | 1205 | "*How much to indent a statement relative to the `case' statement. |
| 1206 | This is for the rc shell." | 1206 | This is for the rc shell." |
| 1207 | :type `(choice ,@ sh-number-or-symbol-list) | 1207 | :type `(choice ,@ sh-number-or-symbol-list) |
| 1208 | :group 'sh-indentation) | 1208 | :group 'sh-indentation) |