Commit Graph

62 Commits

Author SHA1 Message Date
dholland b7b7574d3b Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
2014-07-05 19:22:41 +00:00
dholland c3ab26950f Rework /usr/share/doc.
Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
   - explicit use of soelim
   - refer
   - tbl
   - pic
   - eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
2014-07-05 19:22:02 +00:00
agc 89aaa1bb64 Move UCB-licensed code from 4-clause to 3-clause licence.
Patches provided by Joel Baker in PR 22365, verified by myself.
2003-08-07 11:13:06 +00:00
lukem 001c68bd94 Rename a large chunk of the make(1) variables which refer to a
program/tool from "FOO" to "TOOL_FOO".  The new variables are:
	TOOL_ASN1_COMPILE  TOOL_CAP_MKDB  TOOL_CAT  TOOL_CKSUM  TOOL_COMPILE_ET
	TOOL_CONFIG  TOOL_CRUNCHGEN  TOOL_CTAGS  TOOL_DB  TOOL_EQN  TOOL_FGEN
	TOOL_GENCAT  TOOL_GROFF  TOOL_HEXDUMP  TOOL_INDXBIB  TOOL_INSTALLBOOT
	TOOL_INSTALL_INFO  TOOL_M4  TOOL_MAKEFS  TOOL_MAKEINFO  TOOL_MAKEWHATIS
	TOOL_MDSETIMAGE  TOOL_MENUC  TOOL_MKCSMAPPER  TOOL_MKESDB
	TOOL_MKLOCALE  TOOL_MKMAGIC  TOOL_MKTEMP  TOOL_MSGC  TOOL_MTREE
	TOOL_PAX  TOOL_PIC  TOOL_PREPMKBOOTIMAGE  TOOL_PWD_MKDB  TOOL_REFER
	TOOL_ROFF_ASCII  TOOL_ROFF_DVI  TOOL_ROFF_HTML  TOOL_ROFF_PS
	TOOL_ROFF_RAW  TOOL_RPCGEN  TOOL_SOELIM  TOOL_SUNLABEL  TOOL_TBL
	TOOL_UUDECODE  TOOL_VGRIND  TOOL_ZIC

For each, provide default in <bsd.sys.mk> of the form:
	TOOL_FOO?=	foo
and for the ${USETOOLS}=="yes" case in <bsd.own.mk>, provide override:
	TOOL_FOO=	${TOOLDIR}/bin/${_TOOL_PREFIX}foo

Document all of these in bsd.README.

This cleans up a chunk of potential (and actual) namespace collision
within our build infrastructure, as well as improves consistency in
the share/mk documentation and provision of appropriate defaults for
each of these variables.
2003-07-10 10:33:58 +00:00
pooka 732f4c9fa5 Add ${MACROS} to ${ROFF} usage to make output readable
from jbernard@mines.edu in misc/19685
2003-01-05 12:24:22 +00:00
tv 79ef60507e Goodbye, Berkeley gprof; we shall miss you!
(PSD doc remains here, as it has not lost relevance.)
1999-02-09 18:28:10 +00:00
tv 6f9f9c2a10 Re-enable binutils-based gprof for i386, and disable old gprof on i386. 1999-02-03 00:17:35 +00:00
jonathan e67b964e28 binutils gprof doesn't support mips. Build a.out gprof on mips, to support
kernel profiling.
1998-11-07 17:52:19 +00:00
lukem 9dee5d2b46 don't install in /usr/share if NOSHARE is defined 1998-09-27 17:22:03 +00:00
ragge dd9850d63d Fix erroneous prototypes. 1998-06-09 17:07:12 +00:00
mycroft 23d9d6e9b8 Kluge to make the build not bomb out in here. 1998-05-06 22:02:18 +00:00
mrg 76071c4765 remove register 1998-03-30 02:24:59 +00:00
mrg 91f31df469 avoid extraneous gcc warnings. 1998-03-15 17:14:51 +00:00
jonathan 5e0e8cec39 More table-driven changes for different toolchains:
* new bsd.own.mk variable OBJECT_FMT with values "a.out" or "ELF".
  * use OBJECT_FMT in Makefile tests that depend on toolchain.
  * Add new bsd.own.mk variable NOSHLIB that, if set indicates a given
    port doesnt yet do shared libraries. Set on powerpc.
  * Document new feature-test variables in src/share/mk/bsd.README.
Tested on i386, mips, fakedup Alpha environment.
1998-02-23 10:09:31 +00:00
jonathan 90ba84a41a Remove WARNS= 0 from HEAD. 1998-02-23 01:04:08 +00:00
jonathan f0409ef098 Descend into gprof on all ports to build doc/psd/18.gprof.
Don't define PROG in gprof on ELF or powerpc.
Put back WARNS= 0 for compatibility with 1.3.1.
1998-02-23 01:03:25 +00:00
christos 795e0608f6 WARNSify 1998-02-22 12:55:44 +00:00
christos 6cedf18a50 Work with obj directories 1997-12-21 15:46:33 +00:00
lukem 8ba07ab0b3 use CPPFLAGS instead of CFLAGS 1997-10-24 09:00:17 +00:00
lukem 927f7e1429 use WARNS=0 not WARNS?=0 to disable warnings 1997-10-19 13:01:25 +00:00
mycroft e96e918e60 Use bsd.subdir.mk as appropriate. 1997-10-11 09:34:07 +00:00
mikel 85a9bc4ee4 xref moncontrol(3) instead of obsolete monitor(3), sort xrefs 1997-07-16 06:51:44 +00:00
mikel 3f0dbdf761 xref exit(3) not exit(2) 1997-07-10 07:57:07 +00:00
christos 3917c3179d - Makefile cleanups 1997-03-24 21:57:01 +00:00
matthias 192303707a let the flat profile ignore symbols specified with -E. 1997-01-30 09:20:55 +00:00
thorpej 150c33e60b Use ${INSTALL}. 1996-10-18 05:55:26 +00:00
explorer 35e259ff9e milliseconds, not milleseconds 1996-10-15 18:58:15 +00:00
ragge ae3f8c2815 Updated to work correctly, pointed out by Tom Ivar Helbekkmo. 1996-04-20 14:56:37 +00:00
mark e184b31e47 Include arm32.h when required. 1996-04-01 21:54:06 +00:00
mark 9384681ff5 Initial commit of the machine dependant gprof files for the arm32 port. 1996-04-01 21:51:22 +00:00
jtc c13a492707 Describe PROFDIR environment variable 1995-11-21 22:24:55 +00:00
cgd 2e53911b4d add alpha support files. 1995-04-19 07:24:19 +00:00
cgd ca971e3467 add -D${MACHINE_ARCH} to cflags; machines with new cpp predefs need it. 1995-04-19 07:24:08 +00:00
cgd a1dacc2457 alphabetize machine includes, add alpha 1995-04-19 07:22:59 +00:00
cgd 37302d79a6 clean up RCS ids 1995-04-19 07:15:50 +00:00
pk 07c72b0e78 sparc handles `-c'. 1994-10-19 20:43:24 +00:00
mycroft d8f5a26b66 Fix RCS id format. 1994-10-06 15:39:54 +00:00
mycroft 642d1472ad Don't forget to install .pic files. 1994-09-19 05:08:41 +00:00
cgd 138fcd8327 deal with new share/doc strategy 1994-06-30 05:33:30 +00:00
cgd 5b029eb9a8 update for new doc-make/install strategy 1994-06-25 05:57:47 +00:00
phil 00a29430c0 another missing pc532/ns32k #if 1994-06-09 06:08:35 +00:00
pk e21b88980e At least prevent SIGBUS'es on so called functions (strings in text space). 1994-06-01 11:04:33 +00:00
cgd 0db4129588 clean up import, etc. 1994-05-17 03:35:48 +00:00
cgd f58f08023d new gprof 1994-05-17 03:13:30 +00:00
cgd 22a356d3b5 get it to compile, with new location of gmon.h 1994-05-14 06:26:06 +00:00
cgd 4adebd1261 #if <arch_name> -> #ifdef <arch_name>, per suggestion by phil. 1994-03-09 00:40:39 +00:00
phil ea1ef81d0a Adding the ns32k support. Currently just a copy of the i386 files. 1994-03-09 00:25:14 +00:00
cgd c440ffb67d kill bogus install -d's, and clean slightly 1994-02-10 01:54:10 +00:00
jtc 7e06b2a1e2 Fix spelling errors. 1994-01-11 02:21:43 +00:00
mycroft 1caea71e09 Clean up deleted files. 1993-12-06 05:28:45 +00:00