Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src Reorg docs, part 1:
details: https://anonhg.NetBSD.org/src/rev/47f35bec944a
branches: trunk
changeset: 330333:47f35bec944a
user: dholland <dholland%NetBSD.org@localhost>
date: Sat Jul 05 19:22:41 2014 +0000
description:
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.
diffstat:
bin/csh/USD.doc/Makefile | 4 +-
bin/sh/USD.doc/Makefile | 4 +-
external/bsd/atf/share/doc/atf/Makefile | 4 +-
external/bsd/bind/Makefile.inc | 4 +-
external/bsd/kyua-atf-compat/share/doc/kyua-atf-compat/Makefile | 4 +-
external/bsd/kyua-cli/Makefile.inc | 4 +-
external/bsd/kyua-testers/share/doc/kyua-testers/Makefile | 4 +-
external/bsd/ntp/Makefile.inc | 4 +-
external/bsd/ntp/html/Makefile | 4 +-
external/bsd/nvi/docs/USD.doc/exref/Makefile | 20 +++++---
external/bsd/nvi/docs/USD.doc/vi.ref/Makefile | 4 +-
external/bsd/nvi/docs/USD.doc/vitut/Makefile | 24 ++++++---
external/ibm-public/postfix/Makefile.inc | 4 +-
games/rogue/USD.doc/Makefile | 4 +-
games/trek/USD.doc/Makefile | 4 +-
gnu/usr.bin/groff/contrib/mom/examples/Makefile | 4 +-
gnu/usr.bin/groff/contrib/mom/momdoc/Makefile | 4 +-
lib/libbz2/Makefile | 4 +-
lib/libcurses/PSD.doc/Makefile | 4 +-
share/doc/psd/05.sysman/Makefile | 4 +-
share/doc/psd/20.ipctut/Makefile | 4 +-
share/doc/psd/21.ipc/Makefile | 4 +-
share/doc/smm/04.quotas/Makefile | 4 +-
share/doc/smm/06.nfs/Makefile | 4 +-
share/doc/smm/18.net/Makefile | 4 +-
share/doc/smm/config/Makefile | 4 +-
share/doc/usd/17.msmacros/Makefile | 4 +-
share/doc/usd/18.msdiffs/Makefile | 4 +-
share/doc/usd/19.memacros/Makefile | 4 +-
share/doc/usd/20.meref/Makefile | 4 +-
usr.bin/gprof/Makefile | 4 +-
usr.bin/gprof/PSD.doc/Makefile | 4 +-
usr.bin/mail/USD.doc/Makefile | 4 +-
usr.bin/make/PSD.doc/Makefile | 4 +-
usr.sbin/lpr/SMM.doc/Makefile | 4 +-
usr.sbin/timed/SMM.doc/timed/Makefile | 4 +-
usr.sbin/timed/SMM.doc/timedop/Makefile | 8 +-
37 files changed, 101 insertions(+), 87 deletions(-)
diffs (truncated from 595 to 300 lines):
diff -r 74bab0fc83d3 -r 47f35bec944a bin/csh/USD.doc/Makefile
--- a/bin/csh/USD.doc/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/bin/csh/USD.doc/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.8 2014/07/05 19:22:02 dholland Exp $
+# $NetBSD: Makefile,v 1.9 2014/07/05 19:22:41 dholland Exp $
# @(#)Makefile 8.1 (Berkeley) 8/14/93
-SECTION=usd
+SECTION=reference/ref1
ARTICLE=csh
SRCS= tabs csh.1 csh.2 csh.3 csh.4 csh.ap csh.g
MACROS= -ms
diff -r 74bab0fc83d3 -r 47f35bec944a bin/sh/USD.doc/Makefile
--- a/bin/sh/USD.doc/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/bin/sh/USD.doc/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:02 dholland Exp $
+# $NetBSD: Makefile,v 1.3 2014/07/05 19:22:41 dholland Exp $
# @(#)Makefile 8.1 (Berkeley) 8/14/93
-SECTION=usd
+SECTION=reference/ref1
ARTICLE=shell
SRCS= referargs t.mac t1 t2 t3 t4
MACROS=-ms
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/atf/share/doc/atf/Makefile
--- a/external/bsd/atf/share/doc/atf/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/atf/share/doc/atf/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.6 2014/02/12 04:08:31 jmmv Exp $
+# $NetBSD: Makefile,v 1.7 2014/07/05 19:22:41 dholland Exp $
.include <bsd.init.mk>
@@ -10,7 +10,7 @@
.PATH: ${SRCDIR}/tools
.if ${MKDOC} != "no"
-FILESDIR= /usr/share/doc/atf
+FILESDIR= /usr/share/doc/reference/ref1/atf
FILES= AUTHORS COPYING NEWS README
.endif
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/bind/Makefile.inc
--- a/external/bsd/bind/Makefile.inc Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/bind/Makefile.inc Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.inc,v 1.20 2014/03/07 23:22:26 christos Exp $
+# $NetBSD: Makefile.inc,v 1.21 2014/07/05 19:22:41 dholland Exp $
.if !defined(BIND9_MAKEFILE_INC)
BIND9_MAKEFILE_INC=yes
@@ -27,7 +27,7 @@
IDIST= ${NETBSDSRCDIR}/external/bsd/bind/dist
BIND_SRCDIR= ${NETBSDSRCDIR}/external/bsd/bind
-BIND_HTMLDIR= /usr/share/doc/html/bind9
+BIND_HTMLDIR= /usr/share/doc/reference/ref8/bind9
.include "${IDIST}/version"
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/kyua-atf-compat/share/doc/kyua-atf-compat/Makefile
--- a/external/bsd/kyua-atf-compat/share/doc/kyua-atf-compat/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/kyua-atf-compat/share/doc/kyua-atf-compat/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,9 +1,9 @@
-# $NetBSD: Makefile,v 1.1 2013/02/25 00:20:09 jmmv Exp $
+# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:41 dholland Exp $
.include <bsd.init.mk>
.if ${MKSHARE} != "no"
-FILESDIR= /usr/share/doc/kyua-atf-compat
+FILESDIR= /usr/share/doc/reference/ref1/kyua/kyua-atf-compat
FILESMODE= 444
FILES= AUTHORS COPYING NEWS README
.endif
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/kyua-cli/Makefile.inc
--- a/external/bsd/kyua-cli/Makefile.inc Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/kyua-cli/Makefile.inc Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.inc,v 1.3 2014/02/15 19:42:10 jmmv Exp $
+# $NetBSD: Makefile.inc,v 1.4 2014/07/05 19:22:41 dholland Exp $
.include <bsd.own.mk>
@@ -11,7 +11,7 @@
# Layout of installed files.
KYUA_BINDIR= /usr/bin
KYUA_CONFDIR= /etc/kyua
-KYUA_DOCDIR= /usr/share/doc/kyua-cli
+KYUA_DOCDIR= /usr/share/doc/reference/ref1/kyua/kyua-cli
KYUA_EXAMPLESDIR= /usr/share/examples/kyua-cli
KYUA_MISCDIR= /usr/share/kyua-cli/misc
KYUA_STOREDIR= /usr/share/kyua-cli/store
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/kyua-testers/share/doc/kyua-testers/Makefile
--- a/external/bsd/kyua-testers/share/doc/kyua-testers/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/kyua-testers/share/doc/kyua-testers/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.1 2013/02/24 03:12:59 jmmv Exp $
+# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:41 dholland Exp $
.include <bsd.init.mk>
@@ -8,7 +8,7 @@
.if ${MKSHARE} != "no"
.PATH: ${SRCDIR}
-FILESDIR= /usr/share/doc/kyua-testers
+FILESDIR= /usr/share/doc/reference/ref1/kyua/kyua-testers
FILESMODE= 444
FILES= AUTHORS COPYING NEWS README
.endif
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/ntp/Makefile.inc
--- a/external/bsd/ntp/Makefile.inc Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/ntp/Makefile.inc Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.inc,v 1.13 2014/01/02 21:38:38 joerg Exp $
+# $NetBSD: Makefile.inc,v 1.14 2014/07/05 19:22:41 dholland Exp $
.if !defined(NTP_MAKEFILE_INC)
NTP_MAKEFILE_INC=yes
@@ -17,7 +17,7 @@
IDIST= ${NETBSDSRCDIR}/external/bsd/ntp/dist
NTP_SRCDIR= ${NETBSDSRCDIR}/external/bsd/ntp
-NTP_HTMLDIR= /usr/share/doc/html/ntp
+NTP_HTMLDIR= /usr/share/doc/reference/ref8
SYSCONFDIR=/etc
LOCALSTATEDIR=/var
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/ntp/html/Makefile
--- a/external/bsd/ntp/html/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/ntp/html/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.2 2013/12/28 18:06:41 christos Exp $
+# $NetBSD: Makefile,v 1.3 2014/07/05 19:22:42 dholland Exp $
.include <bsd.own.mk>
.include "${.CURDIR}/../Makefile.inc"
@@ -112,7 +112,7 @@
_FDIR:= ntp/${F:H} # subdir
_FDIR:= ${_FDIR:S,/.$,,} # remove trivial directory
_FNAME:= ${F:T} # name override
-_F:= ${DESTDIR}${HTMLDOCDIR}/${_FDIR}/${_FNAME} # installed path
+_F:= ${DESTDIR}${NTP_HTMLDIR}/${_FDIR}/${_FNAME} # installed path
_FILE:= ${F}
.if ${MKUPDATE} == "no"
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/nvi/docs/USD.doc/exref/Makefile
--- a/external/bsd/nvi/docs/USD.doc/exref/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/nvi/docs/USD.doc/exref/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,11 +1,11 @@
-# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:02 dholland Exp $
+# $NetBSD: Makefile,v 1.3 2014/07/05 19:22:42 dholland Exp $
#
# @(#)Makefile 8.8 (Berkeley) 10/10/96
.include "../../../Makefile.inc"
.PATH: ${DIST}/docs/exref
-SECTION= usd
+SECTION= reference/ref1
ARTICLE= ex
SUBARTICLES= reference summary
SRCS.reference= ex.rm
@@ -13,11 +13,15 @@
MACROS= -ms
ROFF_TBL= yes
EXTRAHTMLFILES= \
- ex1.png ex2.png ex3.png ex4.png ex5.png \
- ex6.png ex7.png ex8.png ex9.png ex10.png \
- ex11.png ex12.png ex13.png ex14.png ex15.png \
- ex16.png ex17.png ex18.png ex19.png ex20.png \
- ex21.png ex22.png ex23.png ex24.png ex25.png \
- ex26.png ex27.png
+ reference1.png reference2.png reference3.png reference4.png \
+ reference5.png reference6.png reference7.png reference8.png \
+ reference9.png reference10.png reference11.png reference12.png \
+ reference13.png reference14.png reference15.png reference16.png \
+ reference17.png reference18.png reference19.png reference20.png \
+ reference21.png reference22.png reference23.png reference24.png \
+ reference25.png reference26.png reference27.png \
+ summary1.png summary2.png summary3.png summary4.png \
+ summary5.png summary6.png summary7.png summary8.png \
+ summary9.png
.include <bsd.doc.mk>
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/nvi/docs/USD.doc/vi.ref/Makefile
--- a/external/bsd/nvi/docs/USD.doc/vi.ref/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/nvi/docs/USD.doc/vi.ref/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,8 +1,8 @@
-# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:02 dholland Exp $
+# $NetBSD: Makefile,v 1.3 2014/07/05 19:22:42 dholland Exp $
#
# @(#)Makefile 8.20 (Berkeley) 8/18/96
-SECTION= usd
+SECTION= reference/ref1
ARTICLE= viref
SRCS= vi.ref
DEPSRCS= ex.cmd.roff set.opt.roff vi.cmd.roff ref.so index.so
diff -r 74bab0fc83d3 -r 47f35bec944a external/bsd/nvi/docs/USD.doc/vitut/Makefile
--- a/external/bsd/nvi/docs/USD.doc/vitut/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/external/bsd/nvi/docs/USD.doc/vitut/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.2 2014/07/05 19:22:03 dholland Exp $
+# $NetBSD: Makefile,v 1.3 2014/07/05 19:22:42 dholland Exp $
#
# @(#)Makefile 8.7 (Berkeley) 8/18/96
@@ -14,12 +14,20 @@
MACROS= -ms
ROFF_TBL= yes
EXTRAHTMLFILES= \
- vi1.png vi2.png vi3.png vi4.png vi5.png \
- vi6.png vi7.png vi8.png vi9.png vi10.png \
- vi11.png vi12.png vi13.png vi14.png vi15.png \
- vi16.png vi17.png vi18.png vi19.png vi20.png \
- vi21.png vi22.png vi23.png vi24.png vi25.png \
- vi26.png vi27.png vi28.png vi29.png vi30.png \
- vi31.png vi32.png vi33.png
+ vitut1.png vitut2.png vitut3.png vitut4.png vitut5.png \
+ vitut6.png vitut7.png vitut8.png vitut9.png vitut10.png \
+ vitut11.png vitut12.png vitut13.png vitut14.png vitut15.png \
+ vitut16.png vitut17.png vitut18.png vitut19.png vitut20.png \
+ vitut21.png vitut22.png vitut23.png vitut24.png vitut25.png \
+ vitut26.png vitut27.png vitut28.png vitut29.png vitut30.png \
+ vitut31.png vitut32.png vitut33.png \
+ summary1.png summary2.png summary3.png summary4.png \
+ summary5.png summary6.png summary7.png summary8.png \
+ summary9.png summary10.png summary11.png summary12.png \
+ summary13.png summary14.png summary15.png summary16.png \
+ summary17.png summary18.png summary19.png summary20.png \
+ summary21.png summary22.png summary23.png summary24.png \
+ summary25.png summary26.png summary27.png summary28.png \
+ summary29.png
.include <bsd.doc.mk>
diff -r 74bab0fc83d3 -r 47f35bec944a external/ibm-public/postfix/Makefile.inc
--- a/external/ibm-public/postfix/Makefile.inc Sat Jul 05 19:22:02 2014 +0000
+++ b/external/ibm-public/postfix/Makefile.inc Sat Jul 05 19:22:41 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.inc,v 1.16 2013/09/11 09:59:13 joerg Exp $
+# $NetBSD: Makefile.inc,v 1.17 2014/07/05 19:22:42 dholland Exp $
.include <bsd.own.mk>
@@ -90,7 +90,7 @@
PFIX_LIBEXECDIR=/usr/libexec/postfix
PFIX_ETCDIR= /etc/postfix
PFIX_EXAMPLEDIR=/usr/share/examples/postfix
-PFIX_HTMLDIR= /usr/share/doc/html/postfix
+PFIX_HTMLDIR= /usr/share/doc/reference/ref8/postfix
PFIX_SBINDIR= /usr/sbin
# override defaults which are otherwise empty and/or so postconf is correct
diff -r 74bab0fc83d3 -r 47f35bec944a games/rogue/USD.doc/Makefile
--- a/games/rogue/USD.doc/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/games/rogue/USD.doc/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.6 2014/07/05 19:22:03 dholland Exp $
+# $NetBSD: Makefile,v 1.7 2014/07/05 19:22:42 dholland Exp $
# @(#)Makefile 8.1 (Berkeley) 6/8/93
-SECTION=usd
+SECTION=reference/ref6
ARTICLE=rogue
SRCS= rogue.me
MACROS= -me
diff -r 74bab0fc83d3 -r 47f35bec944a games/trek/USD.doc/Makefile
--- a/games/trek/USD.doc/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/games/trek/USD.doc/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.5 2014/07/05 19:22:03 dholland Exp $
+# $NetBSD: Makefile,v 1.6 2014/07/05 19:22:42 dholland Exp $
# @(#)Makefile 8.1 (Berkeley) 6/8/93
-SECTION=usd
+SECTION=reference/ref6
ARTICLE=trek
SRCS= trek.me
MACROS= -me
diff -r 74bab0fc83d3 -r 47f35bec944a gnu/usr.bin/groff/contrib/mom/examples/Makefile
--- a/gnu/usr.bin/groff/contrib/mom/examples/Makefile Sat Jul 05 19:22:02 2014 +0000
+++ b/gnu/usr.bin/groff/contrib/mom/examples/Makefile Sat Jul 05 19:22:41 2014 +0000
@@ -1,11 +1,11 @@
-# $NetBSD: Makefile,v 1.8 2010/01/26 15:11:56 wiz Exp $
+# $NetBSD: Makefile,v 1.9 2014/07/05 19:22:42 dholland Exp $
DIST_SUBDIR= contrib/mom/examples
.include <bsd.own.mk>
.if ${MKSHARE} != "no"
-FILESDIR= ${DOCDIR}/groff/mom
+FILESDIR= /usr/share/doc/reference/ref1/roff/mom_examples
MOM_FILES= typesetting.mom letter.mom sample_docs.mom
FILES= README.txt elvis_syntax elvis_syntax.new penguin.ps ${MOM_FILES}
.endif # MKSHARE
Home |
Main Index |
Thread Index |
Old Index