diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-10-26 10:36:46 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-10-26 10:36:46 +0000 |
commit | 6e68d3d4aa900bf9e03f073ed1c2369ed77708bf (patch) | |
tree | cb27ba39bf55534bb75258434eb256bee0b96564 | |
parent | 9ff38b1454e6f97e5bc4a73b821f62bf1c677b23 (diff) | |
download | mandoc-6e68d3d4aa900bf9e03f073ed1c2369ed77708bf.tar.gz |
Fix to segfault in ordering Rs blocks (d'oh!).VERSION.1.9.11
Version: 1.9.11.
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | man.7 | 57 | ||||
-rw-r--r-- | mdoc_action.c | 5 |
3 files changed, 61 insertions, 3 deletions
@@ -9,7 +9,7 @@ INSTALL_DATA = install -m 0444 INSTALL_LIB = install -m 0644 INSTALL_MAN = $(INSTALL_DATA) -VERSION = 1.9.10 +VERSION = 1.9.11 VDATE = 26 October 2009 VFLAGS = -DVERSION="\"$(VERSION)\"" @@ -237,6 +237,63 @@ The \efBfoo\efR utility processes files... \&.\e\*q .SH BUGS \&.\e\*q .SH SECURITY CONSIDERATIONS .Ed +.Pp +The sections in a +.Nm +document are conventionally ordered as they appear above. Sections +should be composed as follows: +.Bl -tag -width Ds -offset Ds +.It NAME +The name(s) and a short description of the documented material. The +syntax for this is generally as follows: +.Pp +.D1 \efBname\efR \e(en description +.It LIBRARY +The name of the library containing the documented material, which is +assumed to be a function in a section 2 or 3 manual. For functions in +the C library, this may be as follows: +.Pp +.D1 Standard C Library (libc, -lc) +.It SYNOPSIS +Documents the utility invocation syntax, function call syntax, or device +configuration. +.Pp +For the first, utilities (sections 1, 6, and 8), this is +generally structured as follows: +.Pp +.D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR... +.Pp +For the second, function calls (sections 2, 3, 9): +.Pp +.D1 \. Ns Sx \&B No char *name(char *\efIarg\efR); +.Pp +And for the third, configurations (section 4): +.Pp +.D1 \. Ns Sx \&B No name* at cardbus ? function ? +.Pp +Manuals not in these sections generally don't need a SYNOPSIS. +.It DESCRIPTION +This expands upon the brief, one-line description in NAME. It usually +contains a break-down of the options (if documenting a command). +.It IMPLEMENTATION NOTES +Implementation-specific notes should be kept here. This is useful when +implementing standard functions that may have side effects or notable +algorithmic implications. +.It EXIT STATUS +.It RETURN VALUES +.It ENVIRONMENT +.It FILES +.It EXAMPLES +.It DIAGNOSTICS +.It ERRORS +.It SEE ALSO +.It STANDARDS +.It HISTORY +.It AUTHORS +.It CAVEATS +.It BUGS +.It SECURITY CONSIDERATIONS +.El . . .Sh MACRO SYNTAX diff --git a/mdoc_action.c b/mdoc_action.c index 4c9ae153..596af7bb 100644 --- a/mdoc_action.c +++ b/mdoc_action.c @@ -192,7 +192,7 @@ static const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* %U */ }; -#define RSORD_MAX 13 +#define RSORD_MAX 14 static const int rsord[RSORD_MAX] = { MDOC__A, @@ -207,7 +207,8 @@ static const int rsord[RSORD_MAX] = { MDOC__Q, MDOC__D, MDOC__O, - MDOC__C + MDOC__C, + MDOC__U }; |