From 7afe8a4e9da86c2e69030ba80f8fb4412d0e1307 Mon Sep 17 00:00:00 2001 From: Kristaps Dzonsons Date: Mon, 23 Feb 2009 13:05:06 +0000 Subject: Added mdoclint. `make regress' uses mdoclint --- README.addmacro | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.addmacro (limited to 'README.addmacro') diff --git a/README.addmacro b/README.addmacro new file mode 100644 index 00000000..8bdea891 --- /dev/null +++ b/README.addmacro @@ -0,0 +1,21 @@ +$Id: README.addmacro,v 1.1 2009/02/23 13:05:06 kristaps Exp $ + +This documents how to go about adding a macro to mdoc.3. + +(1) Add the macro to the #define list in mdoc.h. +(2) Add the macro to __mdoc_macronames in mdoc.c. +(3) Add the macro to __mdoc_macros in mdoc.c. +(4) Add the macro to mdoc_valids in validate.c. +(5) Add the macro to mdoc_actions in action.c. +(6) Add the macro to mdoc_argflags in argv.c. +(7) Modify the hash routine in hash.c (may not be required). + +If the macro has arguments: + +(1) Add arguments to the #define list in mdoc.h. +(2) Add the arguments to __mdoc_argnames in mdoc.c. +(3) Modify parts of argv.c (lookup() and mdoc_args()). + +You'll certainly want to change the front-ends: + +(1) Add the macro to __termacts in term.c. -- cgit v1.2.3