diff options
author | Jun T <takimoto-j@kba.biglobe.ne.jp> | 2014-06-05 23:56:22 +0900 |
---|---|---|
committer | Peter Stephenson <p.w.stephenson@ntlworld.com> | 2014-06-06 22:02:04 +0100 |
commit | d7ca50c8720379d55f7edec3a65bdb12d37c9f52 (patch) | |
tree | 01d17f0688ac8f6eb1be7bce538f5c17be2bb21d | |
parent | 7f6dc0fe8e3c9aaec8aa295cc4459eabb8f2ada2 (diff) | |
download | zsh-d7ca50c8720379d55f7edec3a65bdb12d37c9f52.tar.gz zsh-d7ca50c8720379d55f7edec3a65bdb12d37c9f52.tar.xz zsh-d7ca50c8720379d55f7edec3a65bdb12d37c9f52.zip |
32715: doc formatting fixes
-rw-r--r-- | ChangeLog | 3 | ||||
-rw-r--r-- | Doc/Zsh/calsys.yo | 21 | ||||
-rw-r--r-- | Doc/Zsh/grammar.yo | 51 | ||||
-rw-r--r-- | Doc/Zsh/zle.yo | 20 |
4 files changed, 50 insertions, 45 deletions
diff --git a/ChangeLog b/ChangeLog index 776e4d980..5d9818e20 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2014-06-06 Peter Stephenson <p.w.stephenson@ntlworld.com> + * Jun T: 32715: Doc/Zsh/calsys.yo, Doc/Zsh/grammar.yo, + Doc/Zsh/zle.yo: formatting fixes. + * 32682 with tweaks: Doc/Zsh/options.yo, Src/hist.c, Src/options.c, Src/zsh.h: INC_APPEND_HISTORY_TIME is new behaviour, with INC_APPEND_HISTORY reverting to its previous diff --git a/Doc/Zsh/calsys.yo b/Doc/Zsh/calsys.yo index 7dc51ab11..0d7abbf86 100644 --- a/Doc/Zsh/calsys.yo +++ b/Doc/Zsh/calsys.yo @@ -547,35 +547,36 @@ and status 2 if the wrong number of arguments were passed; it also sets the parameter tt(reply) to an empty associative array. Otherwise, it returns status 0 and sets elements of the associative array tt(reply) as follows: + startsitem() -sitem(time)(The time as a string of digits in the same units as +sitem(tt(time))(The time as a string of digits in the same units as tt($EPOCHSECONDS)) -sitem(schedtime)(The regularly scheduled time. This may differ from +sitem(tt(schedtime))(The regularly scheduled time. This may differ from the actual event time tt(time) if this is a recurring event and the next occurrence has been rescheduled. Then tt(time) gives the actual time and tt(schedtime) the time of the regular recurrence before modification.) -sitem(text1)(The text from the line not including the date and time of the +sitem(tt(text1))(The text from the line not including the date and time of the event, but including any tt(WARN) or tt(RPT) keywords and values.) -sitem(warntime)(Any warning time given by the tt(WARN) keyword as a string +sitem(tt(warntime))(Any warning time given by the tt(WARN) keyword as a string of digits containing the time at which to warn in the same units as tt($EPOCHSECONDS). (Note this is an absolute time, not the relative time passed down.) Not set no tt(WARN) keyword and value were matched.) -sitem(warnstr)(The raw string matched after the tt(WARN) keyword, else unset.) -sitem(rpttime)(Any recurrence time given by the tt(RPT) keyword as a string +sitem(tt(warnstr))(The raw string matched after the tt(WARN) keyword, else unset.) +sitem(tt(rpttime))(Any recurrence time given by the tt(RPT) keyword as a string of digits containing the time of the recurrence in the same units as tt($EPOCHSECONDS). (Note this is an absolute time.) Not set if no tt(RPT) keyword and value were matched.) -sitem(schedrpttime)(The next regularly scheduled occurrence of a recurring +sitem(tt(schedrpttime))(The next regularly scheduled occurrence of a recurring event before modification. This may differ from tt(rpttime), which is the actual time of the event that may have been rescheduled from the regular time.) -sitem(rptstr)(The raw string matched after the tt(RPT) keyword, else unset.) -sitem(text2)(The text from the line after removal of the date and any +sitem(tt(rptstr))(The raw string matched after the tt(RPT) keyword, else unset.) +sitem(tt(text2))(The text from the line after removal of the date and any keywords and values.) ) endsitem() -) + findex(calendar_showdate) item(tt(calendar_showdate) [ tt(-r) ] [ tt(-f) var(fmt) ] var(date-spec ...))( The given var(date-spec) is interpreted and the corresponding date and diff --git a/Doc/Zsh/grammar.yo b/Doc/Zsh/grammar.yo index dde67ebcb..9a1e261ae 100644 --- a/Doc/Zsh/grammar.yo +++ b/Doc/Zsh/grammar.yo @@ -465,37 +465,38 @@ shell constructs such as loops or conditions; this somewhat illogical behaviour can be recovered by setting the option tt(CONTINUE_ON_ERROR). Fatal errors found in non-interactive shells include: -startlist() -list(Failure to parse shell options passed when invoking the shell) -list(Failure to change options with the tt(set) builtin) -list(Parse errors of all sorts, including failures to parse + +startitemize() +itemiz(Failure to parse shell options passed when invoking the shell) +itemiz(Failure to change options with the tt(set) builtin) +itemiz(Parse errors of all sorts, including failures to parse mathematical expressions) -list(Failures to set or modify variable behaviour with tt(typeset), +itemiz(Failures to set or modify variable behaviour with tt(typeset), tt(local), tt(declare), tt(export), tt(integer), tt(float)) -list(Execution of incorrectly positioned loop control structures +itemiz(Execution of incorrectly positioned loop control structures (tt(continue), tt(break))) -list(Attempts to use regular expression with no regular expression +itemiz(Attempts to use regular expression with no regular expression module available) -list(Disallowed operations when the tt(RESTRICTED) options is set) -list(Failure to create a pipe needed for a pipeline) -list(Failure to create a multio) -list(Failure to autoload a module needed for a declared shell feature) -list(Errors creating command or process substitutions) -list(Syntax errors in glob qualifiers) -list(File generation errors where not caught by the option tt(BAD_PATTERN)) -list(All bad patterns used for matching within case statements) -list(File generation failures where not caused by tt(NO_MATCH) or -list(All file generation errors where the pattern was used to create a +itemiz(Disallowed operations when the tt(RESTRICTED) options is set) +itemiz(Failure to create a pipe needed for a pipeline) +itemiz(Failure to create a multio) +itemiz(Failure to autoload a module needed for a declared shell feature) +itemiz(Errors creating command or process substitutions) +itemiz(Syntax errors in glob qualifiers) +itemiz(File generation errors where not caught by the option tt(BAD_PATTERN)) +itemiz(All bad patterns used for matching within case statements) +itemiz(File generation failures where not caused by tt(NO_MATCH) or +itemiz(All file generation errors where the pattern was used to create a multio) -list(Memory errors where detected by the shell) -list(Invalid subscripts to shell variables) -list(Attempts to assign read-only variables) -list(Logical errors with variables such as assignment to the wrong type) -list(Use of invalid variable names) -list(Errors in variable substitution syntax) -list(Failure to convert characters in tt($')...tt(') expressions) +itemiz(Memory errors where detected by the shell) +itemiz(Invalid subscripts to shell variables) +itemiz(Attempts to assign read-only variables) +itemiz(Logical errors with variables such as assignment to the wrong type) +itemiz(Use of invalid variable names) +itemiz(Errors in variable substitution syntax) +itemiz(Failure to convert characters in tt($')...tt(') expressions) similar options) -endlist() +enditemize() If the tt(POSIX_BUILTINS) option is set, more errors associated with shell builtin commands are treated as fatal, as specified by the POSIX diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index 4b1022614..2a907c52c 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -732,16 +732,16 @@ The context in which zle was called to read a line; read-only. One of the values: startitem() -item(start)( +item(tt(start))( The start of a command line (at prompt tt(PS1)). ) -item(cont)( +item(tt(cont))( A continuation to a command line (at prompt tt(PS2)). ) -item(select)( +item(tt(select))( In a tt(select) loop. ) -item(vared)( +item(tt(vared))( Editing a variable in tt(vared). ) enditem() @@ -878,21 +878,21 @@ is needed for character indexing to include tt(PREDISPLAY). Each string consists of the following parts: -startlist() -list(Optionally, a `tt(P)' to signify that the start and end offset that +startitemize() +itemiz(Optionally, a `tt(P)' to signify that the start and end offset that follow include any string set by the tt(PREDISPLAY) special parameter; this is needed if the predisplay string itself is to be highlighted. Whitespace may follow the `tt(P)'.) -list(A start offset in the same units as tt(CURSOR), terminated by +itemiz(A start offset in the same units as tt(CURSOR), terminated by whitespace.) -list(An end offset in the same units as tt(CURSOR), terminated by +itemiz(An end offset in the same units as tt(CURSOR), terminated by whitespace.) -list(A highlight specification in the same format as +itemiz(A highlight specification in the same format as used for contexts in the parameter tt(zle_highlight), ifnzman(noderef(Character Highlighting))\ ifzman(see Character Highlighting below); for example, tt(standout) or tt(fg=red,bold)). -endlist() +enditemize() For example, |