Home | History | Annotate | Download | only in common
History log of /src/distrib/notes/common/macros
RevisionDateAuthorComments
 1.55  05-Feb-2024  andvar s/dependancies/dependencies/ and s/independantly/independently/ in comments and
distrib notes.
 1.54  30-Nov-2019  uwe Improve table of contents.

For .txt and .more drop meaningless page numbers, those formats are
not paginated (with all due respect to line printers, 80s are over).

For .ps use actual formatting with proportional font and properly
aligned page numbers. Thanks to kre@ for his help with some of the
darker corners of troff (with all due respect to my 80s self, he/I
should have paid more attention).
 1.53  29-Nov-2019  uwe Oops, fix typo in .el in previous.
 1.52  29-Nov-2019  uwe Provide separate .Tc and .Ti definitions for HTML and non-HTML.

Change HTML definition of .Tc to enclose TOC into simple .nf/.fi that
also give us <pre> in the output.

This frees our hands to redefine non-HTML case to use better
formatting (work in progress).
 1.51  28-Nov-2019  uwe Don't emit page numbers in TOC for HTML, they are meaningless.
 1.50  28-Nov-2019  uwe Fix typo in register name in previous.
 1.49  28-Nov-2019  uwe Use .open/.write instead of .tm to emit TOC.
 1.48  27-Nov-2019  uwe Don't repeat the TOC file name, define a string.
 1.47  27-Nov-2019  uwe Don't open-code .tm calls to emit TOC entries.

Hide it in an .mktoc macro so that we can switch the way we generate
TOC more easily.
 1.46  27-Nov-2019  uwe Add missing backslash at the start of conditional input.

That avoids an empty line in the input (which didn't look empty, but
for troff it really was) that causes a break.

I don't remember enough linear algebra to understand what happened,
but that also fixes off by one in some page numbers in the TOC.
 1.45  27-Nov-2019  uwe Make .Te and .To also emit .Ti with quoted arguments.

I missed them b/c I tested on sparc notes and sparc/install is stuck
in the 90s and doesn't include common/sysinst. Now that all emitted
.Ti have properly quoted arguments we can revert TOCPROC to simple
grep.

While here convert .Te and .To to also use $* so we we can also drop
quoting from their calls in common/sysinst now. Don't actually drop
those quotes yet though, as we probably can further simplify the call
sites by emitting the headings automatically instead of duplicating
them.
 1.44  27-Nov-2019  martin More cleanup:
- simplify TOC handling and remove arg limit (from uwe)
- use Lk with explicit anchor text in some places
- do not allow official release builds when we can not derive the
proper date from the buildid
 1.43  24-Jan-2018  skrll branches: 1.43.4; 1.43.6;
Remove port-acorn26

OK core@
 1.42  19-May-2015  snj finish removing the set size stuff, which was thrown out four years ago.
 1.41  09-May-2015  snj first pass de-suckification for 2015. modernize content a bit, fix dirty
rotten lies, improve wording, sync legalese with reality, yada yada yada.
 1.40  31-Mar-2014  martin branches: 1.40.4;
Bring back the playstation2 port - now that a toolchain for it is
available again.
 1.39  24-Feb-2014  skrll Rename NetBSD/hp700 to NetBSD/hppa.

Unfortunately our VCS isn't very helpful here.
 1.38  05-Dec-2009  pooka branches: 1.38.6; 1.38.12;
Remove support for NetBSD/playstation2.
 1.37  29-Oct-2008  tsutsui Update MACHINE_LIST and MACHINE_ARCH_LIST.
 1.36  08-Sep-2008  tsutsui Remove obsolete description for old xen-i386 port. Ok'ed by bouyer@.
 1.35  06-Sep-2008  tsutsui Fix warning:
>> ../common/macros:256: warning: number register `Ds' not defined

no changes in generated INSTALL docs.
 1.34  30-Apr-2008  martin branches: 1.34.2;
Convert TNF licenses to new 2 clause variant
 1.33  09-Jan-2008  simonb branches: 1.33.2; 1.33.6; 1.33.8;
Remove support for NetBSD/pc532.
 1.32  23-Jan-2007  itohy branches: 1.32.4;
Use Ns (no space) in definition of Ul (UNIX-like) macro,
since recent groff inserts a space before -like.
 1.31  20-Apr-2006  uwe branches: 1.31.4; 1.31.6;
s/xen/xen-i386/ in MACHINE_ARCH_LIST as that's what the code below expects.
 1.30  10-Nov-2004  abs Fix my mergo when iyonix was added. (signal recieved from wizd via gavan)
 1.29  13-Oct-2004  gavan Initial import of iyonix port.

The Iyonix is a desktop machine from Castle Technology, based on a 600MHz
XScale[tm] 80321 processor.

* Uses the bootloader from NetBSD/acorn32, which is now 32-bit compatible.
* Currently boots multiuser with a serial console.
* Device support is not yet complete.

With help from abs.
 1.28  21-Aug-2004  hubertf update copyright year, and some english nits
 1.27  13-May-2004  cl Add NetBSD/xen documentation.
 1.26  24-Feb-2004  wiz branches: 1.26.2;
becuase -> because. From Peter Postma.
 1.25  10-Oct-2003  mbw add hp700 tags and text
 1.24  09-Dec-2002  scw The walnut port has been subsumed by the new evbppc port.

XXX: There is some work to do here to allow for different
installation notes for different eval boards...
 1.23  22-Jul-2002  lukem - provide .showsize [<G> <U>] to display set size info.
if <G> and <U> aren't provided, use values from last .setsize <G> <U>
reset sizes upon display
- convert to .showsize as appropriate
- fix .el ... .ie
- fix up a bunch of set sizes
- use '-unknown-', '-unset-', and '-unknown-machine-arch-' to flag
unknown set size info (instead of "???")
- consistently use \n[MACHINE] instead of r_MACHINE
- ensure that all MACHINE_ARCH registers are at least defined to 0
- don't bother setting register _\*M
 1.22  08-Jul-2002  lukem define new macro - ".setsize x y" - to print "x MB gzipped, y MB compressed"
and update various size displays appropriately (based in information
obtained from latest autobuild).

XXX: alpha info is now missing, as well as a bunch of x11 sets for
various platforms.
 1.21  29-Jun-2002  lukem update copyright date
 1.20  27-Jun-2002  lukem - sync up MACHINE and MACHINE_ARCH register setting
- clean up whitespace
 1.19  12-May-2002  kleink branches: 1.19.2;
Catch up with recent $MACHINE developments.
 1.18  14-Apr-2002  bjh21 Purge mentions of NetBSD/arm32.
 1.17  29-Mar-2002  bjh21 Add entries for arm and arm32 in the MACHINE -> MACHINE_ARCH map.
 1.16  24-Mar-2002  bjh21 Rename arm26 -> acorn26.
 1.15  03-Dec-2001  jhawk Don't use CURDIR-relative .so for reading the toc, as it breaks
with objdirs.
 1.14  26-Nov-2001  jhawk Add .Te and .To macros for explicit additions to the table of contents.
.Te adds an entry at a specified depth and also outputs the entry name
in the output stream, .To "only" adds the entry. .To is necessaary where
markup issues prevent the use of .Te.
 1.13  26-Nov-2001  jhawk Remove TOC entry for Sh; there are only 3 of them and they're
all on page one and they add needless clutter. Additionally
doc2html doesn't output a tag for them, so we cannot link to them.
Lower indent level for Ss and Ss2
Add special HTML support: emit an HREF on each TOC line. There's some
nasty kludging with extending the dot-leader tab stop by the width
of the href, but that's life in mdoc2html.

TOCs need to be regenerated, but I'm not going to bother for a while.
 1.12  26-Nov-2001  jhawk Add a table of contents (TOC) to the release notes.
This makes it _much_ more user-friendly, as it allows users
to skip to the parts they want easily.
At present, the TOCs are generated files, and can be regenerated
with "make tocs" (probably has to be run twice to account for
the size of the table itself).
TOCs are named INSTALL.{PostScript,ASCII,HTML,more}.toc instead of
INSTALL.{ps,txt,html,more}.toc because that's what \*[format]
expands to.
 1.11  24-Jul-2001  nra Minor spelling fixes.
auxilliary -> auxiliary
concatinate -> concatenate
 1.10  11-Apr-2001  jhawk Why I got nothing done this weekend: Add .Bc/.Ec macros for
columnarized unfilled displays. Not perfect for every scenario,
but work fine for the intended application (common/donations).
 1.9  29-Oct-2000  lukem - add .Key; format a keycap (Literal text, one point size smaller)
- add .Ul; .Ux + '-like' (aka `UNIX-like')
- remove .D2; nothing used it
- add caveat to .(disp
 1.8  11-Oct-2000  tsutsui Fix typo. (s/cobolt/cobalt/)
Pointed out by SUNAGAWA Keiki <kei_sun@ba2.so-net.ne.jp>.
 1.7  10-Oct-2000  lukem - move arch setting logic from main -> macros, and change as follows:
- define string `A' to contain the arch name (defaults to the port
name)
- define registers \*A and _\*A if
- deprecate _FOR_RELEASE, and just use FOR_RELEASE
 1.6  10-Oct-2000  lukem - modify .(tag to be more generic. now takes width as first argument,
and doesn't explicitly provide a .It
- add .(bullet & .bullet), which provide bulleted/hyphenated lists.
(alternates between -bullet & -hyphen at each alternate depth).
.(bullet does .It as well.
- add .(enum & .enum); enumerated list. the former does .It as well
- add .(item & .item); enumerated list. the former does .It as well
- add .Nx*M, which generates `NetBSD/machine', except that `NetBSD'
is done using .Nx so gets the appropriate markup from that
- remove .(note and .note), leaving .(Note and .Note)
- document \*M, \*V, \*[.CURDIR]
 1.5  05-Oct-2000  lukem - remove Bdlit macro; .(disp already exists
- update copyright date
 1.4  04-May-1999  simonb branches: 1.4.8;
Add a html <name> to second-level subsection macro.
 1.3  23-Apr-1999  ross Fix header inversion caused by untracked macro package change.
 1.2  25-Mar-1999  ross branches: 1.2.2;
Stomp on those blank-line-inserting .ne requests, like Charles did
for -mdoc.
 1.1  13-Jan-1999  ross Give the common install notes components their own subdirectory.
Also, alpha and i386 now use a single merged common/sysinst,
and arm32 and sparc have a single merged common/xfer.
 1.2.2.2  05-May-1999  perry pullup 1.3->1.4 (simonb)
 1.2.2.1  23-Apr-1999  perry pullup 1.2->1.3 (ross)
 1.4.8.3  23-Feb-2002  he Pull up revisions 1.11-1.15 (requested by he):
Add Table of Contents to the install notes.
 1.4.8.2  06-May-2001  he Pull up revision 1.10 (requested by he):
Add .Bc/.Ec macros for coloumnarized unfilled displays.
 1.4.8.1  01-Nov-2000  tv Sync to HEAD as of 20001101 03:43 GMT [lukem]:
Complete rework of install notes for 1.5 from several authors.
 1.19.2.3  22-Jul-2002  lukem Pull up revision 1.23 (requested by lukem):
- provide .showsize [<G> <U>] to display set size info.
if <G> and <U> aren't provided, use values from last .setsize <G> <U>
reset sizes upon display
- convert to .showsize as appropriate
- fix .el ... .ie
- fix up a bunch of set sizes
- use '-unknown-', '-unset-', and '-unknown-machine-arch-' to flag
unknown set size info (instead of "???")
- consistently use \n[MACHINE] instead of r_MACHINE
- ensure that all MACHINE_ARCH registers are at least defined to 0
- don't bother setting register _\*M
 1.19.2.2  09-Jul-2002  lukem pullup rev 1.22
 1.19.2.1  02-Jul-2002  lukem manually sync distrib/notes/** to -current, excluding pmppc (which isn't in 1.6)
 1.26.2.1  25-Aug-2004  he Pull up revisions 1.27-1.28 (requested by hubertf in ticket #788):
Updates to installation notes and some tools for handling
certain sections, to better describe the netbsd-2-0 state.
 1.31.6.2  15-Sep-2008  skrll Sync with netbsd-4.
 1.31.6.1  03-Sep-2007  wrstuden Sync w/ NetBSD-4-RC_1
 1.31.4.3  14-Sep-2008  bouyer pullup the following revisions (requested by tsutsui in ticket #1195):
distrib/notes/acorn32/prep.RISCOS 1.19
distrib/notes/common/contents 1.140, 1.141
distrib/notes/common/legal.common 1.51
distrib/notes/common/macros 1.35
distrib/notes/common/main 1.385, 1.387, 1.389 via patch,
1.390-1.394, 1.397-1.403,
1.405 via patch, 1.406-1.407,
1.409, 1.413, 1.415
distrib/notes/common/sysinst 1.86-1.87, 1.90
distrib/notes/common/upgrade 1.24
distrib/notes/hp300/prep 1.22
distrib/notes/i386/hardware 1.122

Various fixes to install notes, including fix display issues
and sync developers lists with reality
 1.31.4.2  29-Sep-2007  pavel branches: 1.31.4.2.2;
Sync the release notes with HEAD.
 1.31.4.1  31-Aug-2007  pavel sync the release notes with -current. The -current ones do not contain
anything specific to post-4.0.
 1.31.4.2.2.1  14-Sep-2008  bouyer pullup the following revisions (requested by tsutsui in ticket #1195):
distrib/notes/acorn32/prep.RISCOS 1.19
distrib/notes/common/contents 1.140, 1.141
distrib/notes/common/legal.common 1.51
distrib/notes/common/macros 1.35
distrib/notes/common/main 1.385, 1.387, 1.389 via patch,
1.390-1.394, 1.397-1.403,
1.405 via patch, 1.406-1.407,
1.409, 1.413, 1.415
distrib/notes/common/sysinst 1.86-1.87, 1.90
distrib/notes/common/upgrade 1.24
distrib/notes/hp300/prep 1.22
distrib/notes/i386/hardware 1.122

Various fixes to install notes, including fix display issues
and sync developers lists with reality
 1.32.4.1  23-Mar-2008  matt sync with HEAD
 1.33.8.1  18-May-2008  yamt sync with head.
 1.33.6.3  05-Oct-2008  mjf Sync with HEAD.
 1.33.6.2  28-Sep-2008  mjf Sync with HEAD.
 1.33.6.1  02-Jun-2008  mjf Sync with HEAD.
 1.33.2.2  09-Jan-2008  simonb Remove support for NetBSD/pc532.
 1.33.2.1  09-Jan-2008  simonb file macros was added on branch mjf-devfs on 2008-01-09 11:25:59 +0000
 1.34.2.2  24-Sep-2008  wrstuden Merge in changes between wrstuden-revivesa-base-2 and
wrstuden-revivesa-base-3.
 1.34.2.1  18-Sep-2008  wrstuden Sync with wrstuden-revivesa-base-2.
 1.38.12.1  19-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.38.6.1  22-May-2014  yamt sync with head.

for a reference, the tree before this commit was tagged
as yamt-pagecache-tag8.

this commit was splitted into small chunks to avoid
a limitation of cvs. ("Protocol error: too many arguments")
 1.40.4.1  24-May-2015  martin Pull up following revision(s) (requested by snj in ticket #799):
distrib/notes/Makefile.inc: revision 1.43
distrib/notes/acorn26/contents: revision 1.2
distrib/notes/acorn26/legal: delete
distrib/notes/acorn32/contents: revision 1.2
distrib/notes/acorn32/hardware: revision 1.3
distrib/notes/acorn32/legal: delete
distrib/notes/acorn32/prep: revision 1.15
distrib/notes/acorn32/prep.RISCOS: revision 1.23
distrib/notes/alpha/contents: revision 1.16
distrib/notes/alpha/hardware: revision 1.18
distrib/notes/alpha/legal: delete
distrib/notes/amd64/contents: revisions 1.4, 1.5
distrib/notes/amd64/legal: delete
distrib/notes/amiga/contents: revision 1.20
distrib/notes/amiga/legal: delete
distrib/notes/arc/contents: revision 1.2
distrib/notes/arc/legal: delete
distrib/notes/atari/contents: revision 1.20
distrib/notes/atari/legal: delete
distrib/notes/bebox/contents: revision 1.2
distrib/notes/bebox/hardware: revision 1.2
distrib/notes/bebox/legal: delete
distrib/notes/cats/contents: revision 1.2
distrib/notes/cats/legal: delete
distrib/notes/common/legal.common: revisions 1.93-1.96
distrib/notes/common/list-setsizes.sh: delete
distrib/notes/common/macros: revisions 1.41, 1.42
distrib/notes/common/main: revisions 1.519-1.521
distrib/notes/common/netboot: revision 1.36
distrib/notes/common/postinstall: revision 1.80, 1.81
distrib/notes/common/sysinst: revisions 1.105, 1.106
distrib/notes/common/upgrade: revisions 1.29, 1.30
distrib/notes/common/xfer: revision 1.74
distrib/notes/emips/contents: revision 1.2
distrib/notes/emips/hardware: revision 1.2
distrib/notes/emips/install: revision 1.2
distrib/notes/emips/legal: delete
distrib/notes/evbarm/contents: revision 1.2
distrib/notes/evbarm/legal: delete
distrib/notes/evbppc/contents: revision 1.3
distrib/notes/evbppc/legal: delete
distrib/notes/ews4800mips/contents: revision 1.2
distrib/notes/ews4800mips/legal: delete
distrib/notes/hp300/contents: revision 1.17
distrib/notes/hp300/legal: delete
distrib/notes/hpcarm/contents: revision 1.3
distrib/notes/hpcarm/legal: delete
distrib/notes/hpcmips/contents: revision 1.10
distrib/notes/hpcmips/legal: delete
distrib/notes/hpcsh/contents: revision 1.3
distrib/notes/hpcsh/legal: delete
distrib/notes/hppa/contents: revision 1.2
distrib/notes/hppa/legal: delete
distrib/notes/i386/contents: revision 1.29
distrib/notes/i386/legal: delete
distrib/notes/landisk/contents: revision 1.3
distrib/notes/landisk/legal: delete
distrib/notes/mac68k/contents: revision 1.20
distrib/notes/mac68k/hardware: revision 1.25
distrib/notes/mac68k/legal: delete
distrib/notes/mac68k/prep: revision 1.17
distrib/notes/macppc/contents: revision 1.11
distrib/notes/macppc/hardware: revision 1.48
distrib/notes/macppc/legal: delete
distrib/notes/macppc/prep.OPENFIRMWARE: revision 1.18
distrib/notes/mmeye/contents: revision 1.3
distrib/notes/mmeye/legal: delete
distrib/notes/mvme68k/contents: revision 1.13
distrib/notes/mvme68k/legal: delete
distrib/notes/mvme68k/xfer: revision 1.18
distrib/notes/news68k/contents: revision 1.6
distrib/notes/news68k/legal: delete
distrib/notes/newsmips/contents: revision 1.2
distrib/notes/newsmips/legal: delete
distrib/notes/next68k/contents: revision 1.7
distrib/notes/next68k/legal: delete
distrib/notes/ofppc/contents: revision 1.3
distrib/notes/ofppc/legal: delete
distrib/notes/pmax/contents: revision 1.17
distrib/notes/pmax/hardware: revision 1.18
distrib/notes/pmax/legal: delete
distrib/notes/prep/contents: revision 1.2
distrib/notes/prep/hardware: revision 1.5
distrib/notes/prep/legal: delete
distrib/notes/prep/upgrade: revision 1.2
distrib/notes/rs6000/contents: revision 1.2
distrib/notes/rs6000/legal: delete
distrib/notes/sandpoint/contents: revision 1.2
distrib/notes/sandpoint/legal: delete
distrib/notes/sgimips/contents: revision 1.2
distrib/notes/sgimips/legal: delete
distrib/notes/shark/contents: revision 1.2
distrib/notes/shark/legal: delete
distrib/notes/sparc/contents: revision 1.21
distrib/notes/sparc/hardware: revision 1.37
distrib/notes/sparc/legal: delete
distrib/notes/sparc/prep: revision 1.27
distrib/notes/sparc64/Makefile: revision 1.4
distrib/notes/sparc64/contents: revision 1.5
distrib/notes/sparc64/hardware: revision 1.28
distrib/notes/sparc64/legal: delete
distrib/notes/sun2/contents: revision 1.2
distrib/notes/sun2/legal: delete
distrib/notes/sun3/contents: revision 1.16
distrib/notes/sun3/legal: delete
distrib/notes/vax/contents: revision 1.11
distrib/notes/vax/hardware: revision 1.11
distrib/notes/vax/legal: delete
distrib/notes/x68k/contents: revision 1.17
distrib/notes/x68k/hardware: revision 1.18
distrib/notes/x68k/legal: delete
distrib/notes/xen/legal: delete
Remove reference to a 14 year old IP address for ftp.NetBSD.org.
This is not a joke.
--
mention etcupdate and reorder a bit
--
first pass de-suckification for 2015. modernize content a bit, fix dirty
rotten lies, improve wording, sync legalese with reality, yada yada yada.
--
This product includes software developed by Yasushi Yamasaki.
--
- update upgrade issues:
+ ARM ABI change
+ new users
+ new groups
- add modules set where missing
- formatting improvements
- note that rtsol{,d} will be gone in the future
- fix raw partition info
- update sparc64 hardware support
- remove note about sparc SMP support being broken
- update some size requirements (still lots of ancient bogus RAM
minimums lingering -- HI PORTMASTERS!)
- various other minor content modernization
- whitespace fixes
--
finish removing the set size stuff, which was thrown out four years ago.
--
merge port-specific legal sections into the common file. most of these
entries were already in the common file, and it's a pain to maintain
them separately.
--
don't look for now-gone sparc/legal
--
restore rcsid accidentally deleted in previous
--
bah. this time without a typo.
 1.43.6.2  09-Dec-2019  martin Pull up the following revisions, requested by uwe in ticket #523:

distrib/notes/Makefile.inc up to 1.52
distrib/notes/common/macros up to 1.54

Improve table of contents.
 1.43.6.1  27-Nov-2019  msaitoh Pull up following revision(s) (requested by martin in ticket #489):
distrib/notes/Makefile.inc: revision 1.46
distrib/notes/common/postinstall: revision 1.86
distrib/notes/sparc64/prep: revision 1.16
distrib/notes/common/netboot: revision 1.38
distrib/notes/common/main: revision 1.555
distrib/notes/common/main: revision 1.556
distrib/notes/common/main: revision 1.557
distrib/notes/common/macros: revision 1.44
distrib/notes/common/sysinst: revision 1.110
distrib/notes/sparc/prep: revision 1.28
distrib/notes/sparc/prep: revision 1.29
distrib/notes/common/list-portmasters.pl: file removal
Remove list-portmasters.pl script.
We dropped that list from "main" some time ago.
Quote long .Ss2 title to avoid troff's limitation.
Troff is limited to 9 macro parameters and this title is 10 words, so
we lose the last word here when we pass arguments around. We have
more titles like that but for now I wanted to commit only one just to
flag the problem.
More cleanup:
- simplify TOC handling and remove arg limit (from uwe)
- use Lk with explicit anchor text in some places
- do not allow official release builds when we can not derive the
proper date from the buildid
Add "Oxford comma"
Improve heading a bit. While here, use quotes to group some of the
words to avoid the 9-arg limitation of .Ss
 1.43.4.1  08-Apr-2020  martin Merge changes from current as of 20200406

RSS XML Feed