diff options
| author | Juanma Barranquero | 2010-03-22 17:37:32 +0100 |
|---|---|---|
| committer | Juanma Barranquero | 2010-03-22 17:37:32 +0100 |
| commit | 5f76fe28b98ceec8ab3a7aacc4a0281679d818ee (patch) | |
| tree | 30013e404764e0b097ef8376e4dde8557710798c | |
| parent | 2b8f62e98615abf8f6d0dae77e37ff7cb01e91b7 (diff) | |
| download | emacs-5f76fe28b98ceec8ab3a7aacc4a0281679d818ee.tar.gz emacs-5f76fe28b98ceec8ab3a7aacc4a0281679d818ee.zip | |
Fix typos in mh-e.
* mh-scan.el (mh-scan-cmd-note-width): Doc fix.
(mh-scan-format-mh, mh-scan-body-regexp, mh-scan-cur-msg-number-regexp)
(mh-scan-cur-msg-number-regexp, mh-scan-date-regexp)
(mh-scan-deleted-msg-regexp, mh-scan-good-msg-regexp)
(mh-scan-msg-format-regexp, mh-scan-msg-format-string)
(mh-scan-msg-number-regexp, mh-scan-rcpt-regexp)
(mh-scan-refiled-msg-regexp, mh-scan-sent-to-me-sender-regexp)
(mh-scan-subject-regexp, mh-update-scan-format)
(mh-msg-num-width-to-column): Fix typos in docstrings.
| -rw-r--r-- | lisp/mh-e/ChangeLog | 12 | ||||
| -rw-r--r-- | lisp/mh-e/mh-scan.el | 62 |
2 files changed, 43 insertions, 31 deletions
diff --git a/lisp/mh-e/ChangeLog b/lisp/mh-e/ChangeLog index 83d5e391ffd..70f96e0dbc7 100644 --- a/lisp/mh-e/ChangeLog +++ b/lisp/mh-e/ChangeLog | |||
| @@ -1,3 +1,15 @@ | |||
| 1 | 2010-03-22 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * mh-scan.el (mh-scan-cmd-note-width): Doc fix. | ||
| 4 | (mh-scan-format-mh, mh-scan-body-regexp, mh-scan-cur-msg-number-regexp) | ||
| 5 | (mh-scan-cur-msg-number-regexp, mh-scan-date-regexp) | ||
| 6 | (mh-scan-deleted-msg-regexp, mh-scan-good-msg-regexp) | ||
| 7 | (mh-scan-msg-format-regexp, mh-scan-msg-format-string) | ||
| 8 | (mh-scan-msg-number-regexp, mh-scan-rcpt-regexp) | ||
| 9 | (mh-scan-refiled-msg-regexp, mh-scan-sent-to-me-sender-regexp) | ||
| 10 | (mh-scan-subject-regexp, mh-update-scan-format) | ||
| 11 | (mh-msg-num-width-to-column): Fix typos in docstrings. | ||
| 12 | |||
| 1 | 2009-12-01 Bill Wohler <wohler@newt.com> | 13 | 2009-12-01 Bill Wohler <wohler@newt.com> |
| 2 | 14 | ||
| 3 | * mh-search.el (mh-mairix-execute-search): Use mh vfolder_format. | 15 | * mh-search.el (mh-mairix-execute-search): Use mh vfolder_format. |
diff --git a/lisp/mh-e/mh-scan.el b/lisp/mh-e/mh-scan.el index fd812c80f47..5f5a84f07a6 100644 --- a/lisp/mh-e/mh-scan.el +++ b/lisp/mh-e/mh-scan.el | |||
| @@ -61,7 +61,7 @@ | |||
| 61 | "%{subject}%<{body}<<%{body}%>") | 61 | "%{subject}%<{body}<<%{body}%>") |
| 62 | "*Scan format string for MH. | 62 | "*Scan format string for MH. |
| 63 | This string is passed to the scan program via the -format | 63 | This string is passed to the scan program via the -format |
| 64 | argument. This format is identical to the default except that | 64 | argument. This format is identical to the default except that |
| 65 | additional hints for fontification have been added to the fifth | 65 | additional hints for fontification have been added to the fifth |
| 66 | column (remember that in Emacs, the first column is 0). | 66 | column (remember that in Emacs, the first column is 0). |
| 67 | 67 | ||
| @@ -109,14 +109,14 @@ non-empty Newsgroups: field is present.") | |||
| 109 | Note that the default setting of `mh-folder-font-lock-keywords' | 109 | Note that the default setting of `mh-folder-font-lock-keywords' |
| 110 | expects this expression to contain at least one parenthesized | 110 | expects this expression to contain at least one parenthesized |
| 111 | expression which matches the body text as in the default of | 111 | expression which matches the body text as in the default of |
| 112 | \"\\\\(<<\\\\([^\\n]+\\\\)?\\\\)\". If this regular expression is | 112 | \"\\\\(<<\\\\([^\\n]+\\\\)?\\\\)\". If this regular expression is |
| 113 | not correct, the body fragment will not be highlighted with the | 113 | not correct, the body fragment will not be highlighted with the |
| 114 | face `mh-folder-body'.") | 114 | face `mh-folder-body'.") |
| 115 | 115 | ||
| 116 | (defvar mh-scan-cur-msg-number-regexp "^\\( *[0-9]+\\+\\).*" | 116 | (defvar mh-scan-cur-msg-number-regexp "^\\( *[0-9]+\\+\\).*" |
| 117 | "This regular expression matches the current message. | 117 | "This regular expression matches the current message. |
| 118 | 118 | ||
| 119 | It must match from the beginning of the line. Note that the | 119 | It must match from the beginning of the line. Note that the |
| 120 | default setting of `mh-folder-font-lock-keywords' expects this | 120 | default setting of `mh-folder-font-lock-keywords' expects this |
| 121 | expression to contain at least one parenthesized expression which | 121 | expression to contain at least one parenthesized expression which |
| 122 | matches the message number as in the default of | 122 | matches the message number as in the default of |
| @@ -125,9 +125,9 @@ matches the message number as in the default of | |||
| 125 | 125 | ||
| 126 | This expression includes the leading space and current message | 126 | This expression includes the leading space and current message |
| 127 | marker \"+\" within the parenthesis since it looks better to | 127 | marker \"+\" within the parenthesis since it looks better to |
| 128 | highlight these items as well. The highlighting is done with the | 128 | highlight these items as well. The highlighting is done with the |
| 129 | face `mh-folder-cur-msg-number'. This regular expression should | 129 | face `mh-folder-cur-msg-number'. This regular expression should |
| 130 | be correct as it is needed by non-fontification functions. See | 130 | be correct as it is needed by non-fontification functions. See |
| 131 | also `mh-note-cur'.") | 131 | also `mh-note-cur'.") |
| 132 | 132 | ||
| 133 | (defvar mh-scan-date-regexp "\\([0-9][0-9]/[0-9][0-9]\\)" | 133 | (defvar mh-scan-date-regexp "\\([0-9][0-9]/[0-9][0-9]\\)" |
| @@ -137,14 +137,14 @@ It must not be anchored to the beginning or the end of the line. | |||
| 137 | Note that the default setting of `mh-folder-font-lock-keywords' | 137 | Note that the default setting of `mh-folder-font-lock-keywords' |
| 138 | expects this expression to contain only one parenthesized | 138 | expects this expression to contain only one parenthesized |
| 139 | expression which matches the date field as in the default of | 139 | expression which matches the date field as in the default of |
| 140 | \"\\\\([0-9][0-9]/[0-9][0-9]\\\\)\"}. If this regular expression | 140 | \"\\\\([0-9][0-9]/[0-9][0-9]\\\\)\"}. If this regular expression |
| 141 | is not correct, the date will not be highlighted with the face | 141 | is not correct, the date will not be highlighted with the face |
| 142 | `mh-folder-date'.") | 142 | `mh-folder-date'.") |
| 143 | 143 | ||
| 144 | (defvar mh-scan-deleted-msg-regexp "^\\( *[0-9]+\\)D" | 144 | (defvar mh-scan-deleted-msg-regexp "^\\( *[0-9]+\\)D" |
| 145 | "This regular expression matches deleted messages. | 145 | "This regular expression matches deleted messages. |
| 146 | 146 | ||
| 147 | It must match from the beginning of the line. Note that the | 147 | It must match from the beginning of the line. Note that the |
| 148 | default setting of `mh-folder-font-lock-keywords' expects this | 148 | default setting of `mh-folder-font-lock-keywords' expects this |
| 149 | expression to contain at least one parenthesized expression which | 149 | expression to contain at least one parenthesized expression which |
| 150 | matches the message number as in the default of | 150 | matches the message number as in the default of |
| @@ -152,15 +152,15 @@ matches the message number as in the default of | |||
| 152 | \"^\\\\( *[0-9]+\\\\)D\". | 152 | \"^\\\\( *[0-9]+\\\\)D\". |
| 153 | 153 | ||
| 154 | This expression includes the leading space within the parenthesis | 154 | This expression includes the leading space within the parenthesis |
| 155 | since it looks better to highlight it as well. The highlighting | 155 | since it looks better to highlight it as well. The highlighting |
| 156 | is done with the face `mh-folder-deleted'. This regular | 156 | is done with the face `mh-folder-deleted'. This regular |
| 157 | expression should be correct as it is needed by non-fontification | 157 | expression should be correct as it is needed by non-fontification |
| 158 | functions. See also `mh-note-deleted'.") | 158 | functions. See also `mh-note-deleted'.") |
| 159 | 159 | ||
| 160 | (defvar mh-scan-good-msg-regexp "^\\( *[0-9]+\\)[^D^0-9]" | 160 | (defvar mh-scan-good-msg-regexp "^\\( *[0-9]+\\)[^D^0-9]" |
| 161 | "This regular expression matches \"good\" messages. | 161 | "This regular expression matches \"good\" messages. |
| 162 | 162 | ||
| 163 | It must match from the beginning of the line. Note that the | 163 | It must match from the beginning of the line. Note that the |
| 164 | default setting of `mh-folder-font-lock-keywords' expects this | 164 | default setting of `mh-folder-font-lock-keywords' expects this |
| 165 | expression to contain at least one parenthesized expression which | 165 | expression to contain at least one parenthesized expression which |
| 166 | matches the message number as in the default of | 166 | matches the message number as in the default of |
| @@ -168,8 +168,8 @@ matches the message number as in the default of | |||
| 168 | \"^\\\\( *[0-9]+\\\\)[^D^0-9]\". | 168 | \"^\\\\( *[0-9]+\\\\)[^D^0-9]\". |
| 169 | 169 | ||
| 170 | This expression includes the leading space within the parenthesis | 170 | This expression includes the leading space within the parenthesis |
| 171 | since it looks better to highlight it as well. The highlighting | 171 | since it looks better to highlight it as well. The highlighting |
| 172 | is done with the face `mh-folder-msg-number'. This regular | 172 | is done with the face `mh-folder-msg-number'. This regular |
| 173 | expression should be correct as it is needed by non-fontification | 173 | expression should be correct as it is needed by non-fontification |
| 174 | functions.") | 174 | functions.") |
| 175 | 175 | ||
| @@ -177,21 +177,21 @@ functions.") | |||
| 177 | "This regular expression finds the message number width in a scan format. | 177 | "This regular expression finds the message number width in a scan format. |
| 178 | 178 | ||
| 179 | Note that the message number must be placed in a parenthesized | 179 | Note that the message number must be placed in a parenthesized |
| 180 | expression as in the default of \"%\\\\([0-9]*\\\\)(msg)\". This | 180 | expression as in the default of \"%\\\\([0-9]*\\\\)(msg)\". This |
| 181 | variable is only consulted if `mh-scan-format-file' is set to | 181 | variable is only consulted if `mh-scan-format-file' is set to |
| 182 | \"Use MH-E scan Format\".") | 182 | \"Use MH-E scan Format\".") |
| 183 | 183 | ||
| 184 | (defvar mh-scan-msg-format-string "%d" | 184 | (defvar mh-scan-msg-format-string "%d" |
| 185 | "This is a format string for width of the message number in a scan format. | 185 | "This is a format string for width of the message number in a scan format. |
| 186 | 186 | ||
| 187 | Use \"0%d\" for zero-filled message numbers. This variable is only | 187 | Use \"0%d\" for zero-filled message numbers. This variable is only |
| 188 | consulted if `mh-scan-format-file' is set to \"Use MH-E scan | 188 | consulted if `mh-scan-format-file' is set to \"Use MH-E scan |
| 189 | Format\".") | 189 | Format\".") |
| 190 | 190 | ||
| 191 | (defvar mh-scan-msg-number-regexp "^ *\\([0-9]+\\)" | 191 | (defvar mh-scan-msg-number-regexp "^ *\\([0-9]+\\)" |
| 192 | "This regular expression extracts the message number. | 192 | "This regular expression extracts the message number. |
| 193 | 193 | ||
| 194 | It must match from the beginning of the line. Note that the | 194 | It must match from the beginning of the line. Note that the |
| 195 | message number must be placed in a parenthesized expression as in | 195 | message number must be placed in a parenthesized expression as in |
| 196 | the default of \"^ *\\\\([0-9]+\\\\)\".") | 196 | the default of \"^ *\\\\([0-9]+\\\\)\".") |
| 197 | 197 | ||
| @@ -211,9 +211,9 @@ message number within the expression as in the default of | |||
| 211 | Note that the default setting of `mh-folder-font-lock-keywords' | 211 | Note that the default setting of `mh-folder-font-lock-keywords' |
| 212 | expects this expression to contain two parenthesized expressions. | 212 | expects this expression to contain two parenthesized expressions. |
| 213 | The first is expected to match the \"To:\" that the default scan | 213 | The first is expected to match the \"To:\" that the default scan |
| 214 | format file generates. The second is expected to match the | 214 | format file generates. The second is expected to match the |
| 215 | recipient's name as in the default of | 215 | recipient's name as in the default of |
| 216 | \"\\\\(To:\\\\)\\\\(..............\\\\)\". If this regular | 216 | \"\\\\(To:\\\\)\\\\(..............\\\\)\". If this regular |
| 217 | expression is not correct, the \"To:\" string will not be | 217 | expression is not correct, the \"To:\" string will not be |
| 218 | highlighted with the face `mh-folder-to' and the recipient will | 218 | highlighted with the face `mh-folder-to' and the recipient will |
| 219 | not be highlighted with the face `mh-folder-address'") | 219 | not be highlighted with the face `mh-folder-address'") |
| @@ -221,7 +221,7 @@ not be highlighted with the face `mh-folder-address'") | |||
| 221 | (defvar mh-scan-refiled-msg-regexp "^\\( *[0-9]+\\)\\^" | 221 | (defvar mh-scan-refiled-msg-regexp "^\\( *[0-9]+\\)\\^" |
| 222 | "This regular expression matches refiled messages. | 222 | "This regular expression matches refiled messages. |
| 223 | 223 | ||
| 224 | It must match from the beginning of the line. Note that the | 224 | It must match from the beginning of the line. Note that the |
| 225 | default setting of `mh-folder-font-lock-keywords' expects this | 225 | default setting of `mh-folder-font-lock-keywords' expects this |
| 226 | expression to contain at least one parenthesized expression which | 226 | expression to contain at least one parenthesized expression which |
| 227 | matches the message number as in the default of | 227 | matches the message number as in the default of |
| @@ -229,10 +229,10 @@ matches the message number as in the default of | |||
| 229 | \"^\\\\( *[0-9]+\\\\)\\\\^\". | 229 | \"^\\\\( *[0-9]+\\\\)\\\\^\". |
| 230 | 230 | ||
| 231 | This expression includes the leading space within the parenthesis | 231 | This expression includes the leading space within the parenthesis |
| 232 | since it looks better to highlight it as well. The highlighting | 232 | since it looks better to highlight it as well. The highlighting |
| 233 | is done with the face `mh-folder-refiled'. This regular | 233 | is done with the face `mh-folder-refiled'. This regular |
| 234 | expression should be correct as it is needed by non-fontification | 234 | expression should be correct as it is needed by non-fontification |
| 235 | functions. See also `mh-note-refiled'.") | 235 | functions. See also `mh-note-refiled'.") |
| 236 | 236 | ||
| 237 | (defvar mh-scan-sent-to-me-sender-regexp | 237 | (defvar mh-scan-sent-to-me-sender-regexp |
| 238 | "^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)" | 238 | "^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)" |
| @@ -240,7 +240,7 @@ functions. See also `mh-note-refiled'.") | |||
| 240 | 240 | ||
| 241 | Note that the default setting of `mh-folder-font-lock-keywords' | 241 | Note that the default setting of `mh-folder-font-lock-keywords' |
| 242 | expects this expression to contain at least two parenthesized | 242 | expects this expression to contain at least two parenthesized |
| 243 | expressions. The first should match the fontification hint (see | 243 | expressions. The first should match the fontification hint (see |
| 244 | `mh-scan-format-nmh') and the second should match the user name | 244 | `mh-scan-format-nmh') and the second should match the user name |
| 245 | as in the default of | 245 | as in the default of |
| 246 | 246 | ||
| @@ -255,15 +255,15 @@ highlighted with the face `mh-folder-sent-to-me-sender'.") | |||
| 255 | "^ *[0-9]+........[ ]*...................\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)" | 255 | "^ *[0-9]+........[ ]*...................\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)" |
| 256 | "This regular expression matches the subject. | 256 | "This regular expression matches the subject. |
| 257 | 257 | ||
| 258 | It must match from the beginning of the line. Note that the | 258 | It must match from the beginning of the line. Note that the |
| 259 | default setting of `mh-folder-font-lock-keywords' expects this | 259 | default setting of `mh-folder-font-lock-keywords' expects this |
| 260 | expression to contain at least three parenthesized expressions. | 260 | expression to contain at least three parenthesized expressions. |
| 261 | The first is expected to match the \"Re:\" string, if any, and is | 261 | The first is expected to match the \"Re:\" string, if any, and is |
| 262 | highlighted with the face `mh-folder-followup'. The second | 262 | highlighted with the face `mh-folder-followup'. The second |
| 263 | matches an optional bracketed number after \"Re:\", such as in | 263 | matches an optional bracketed number after \"Re:\", such as in |
| 264 | \"Re[2]:\" (and is thus a sub-expression of the first expression) | 264 | \"Re[2]:\" (and is thus a sub-expression of the first expression) |
| 265 | and the third is expected to match the subject line itself which | 265 | and the third is expected to match the subject line itself which |
| 266 | is highlighted with the face `mh-folder-subject'. For example, | 266 | is highlighted with the face `mh-folder-subject'. For example, |
| 267 | the default (broken on multiple lines for readability) is | 267 | the default (broken on multiple lines for readability) is |
| 268 | 268 | ||
| 269 | ^ *[0-9]+........[ ]*................... | 269 | ^ *[0-9]+........[ ]*................... |
| @@ -296,9 +296,9 @@ Note that columns in Emacs start with 0.") | |||
| 296 | (defvar mh-scan-cmd-note-width 1 | 296 | (defvar mh-scan-cmd-note-width 1 |
| 297 | "Number of columns consumed by the cmd-note field in `mh-scan-format'. | 297 | "Number of columns consumed by the cmd-note field in `mh-scan-format'. |
| 298 | 298 | ||
| 299 | This column will have one of the values: \" \", \"D\", \"^\", \"+\" and | 299 | This column will have one of the values: \" \", \"D\", \"^\", \"+\", where |
| 300 | where \" \" is the default value, | ||
| 301 | 300 | ||
| 301 | \" \" is the default value, | ||
| 302 | \"D\" is the `mh-note-deleted' character, | 302 | \"D\" is the `mh-note-deleted' character, |
| 303 | \"^\" is the `mh-note-refiled' character, and | 303 | \"^\" is the `mh-note-refiled' character, and |
| 304 | \"+\" is the `mh-note-cur' character.") | 304 | \"+\" is the `mh-note-cur' character.") |
| @@ -434,7 +434,7 @@ Note that columns in Emacs start with 0." | |||
| 434 | "Return a scan format with the (msg) width in the FMT replaced with WIDTH. | 434 | "Return a scan format with the (msg) width in the FMT replaced with WIDTH. |
| 435 | 435 | ||
| 436 | The message number width portion of the format is discovered | 436 | The message number width portion of the format is discovered |
| 437 | using `mh-scan-msg-format-regexp'. Its replacement is controlled | 437 | using `mh-scan-msg-format-regexp'. Its replacement is controlled |
| 438 | with `mh-scan-msg-format-string'." | 438 | with `mh-scan-msg-format-string'." |
| 439 | (or (and | 439 | (or (and |
| 440 | (string-match mh-scan-msg-format-regexp fmt) | 440 | (string-match mh-scan-msg-format-regexp fmt) |
| @@ -469,7 +469,7 @@ Note that columns in Emacs start with 0. | |||
| 469 | 469 | ||
| 470 | If `mh-scan-format-file' is set to \"Use MH-E scan Format\" this | 470 | If `mh-scan-format-file' is set to \"Use MH-E scan Format\" this |
| 471 | means that either `mh-scan-format-mh' or `mh-scan-format-nmh' are | 471 | means that either `mh-scan-format-mh' or `mh-scan-format-nmh' are |
| 472 | in use. This function therefore assumes that the first column is | 472 | in use. This function therefore assumes that the first column is |
| 473 | empty (to provide room for the cursor), the following WIDTH | 473 | empty (to provide room for the cursor), the following WIDTH |
| 474 | columns contain the message number, and the column for notations | 474 | columns contain the message number, and the column for notations |
| 475 | comes after that." | 475 | comes after that." |