Commit Graph

135 Commits

Author SHA1 Message Date
joe
0efe0bb3cb Scripts should contain a comment block describing what the script does. 2000-10-19 18:18:35 +00:00
joe
e1d76cbbc6 Reference Larry Wall's perlstyle man page, and recommend it's use where
entries in this guide don't override it.

Requested by:	markm

Comment on tabulation style.
2000-10-18 21:57:37 +00:00
joe
784dd58645 Use 'unless' instead of 'if (! ... )' where it improves readability. 2000-10-18 18:01:35 +00:00
joe
e8f6f29b2c Opening braces should be at the end of the controlling line. Else
and elsif belong on the same line as the closing brace for the
previous if or elsif block.

Suggested by:	des
2000-10-18 17:48:10 +00:00
joe
3b94882f32 Contract a statement that's too verbose. 2000-10-18 17:34:43 +00:00
joe
c3bcc6f189 There are enough examples of using 'my $var = ...' definitions, so remove
one.
2000-10-18 17:32:21 +00:00
joe
aa9061a17f All variables should be commented.
Local variables should be separated from function arguments by a
blank line.

Suggested by:	des
2000-10-18 17:25:59 +00:00
joe
d1eac60c8c Make subroutine prototypes mandatory.
The main code should be wrapped in a MAIN:{ ... } declaration.

Suggested by:	des
2000-10-18 17:21:54 +00:00
joe
440545207b Fix the places that I missed last commit: 'vars' not 'var'. 2000-10-18 17:12:07 +00:00
joe
64c0465316 Correction: 'use vars ..' not 'use var'.
Submitted by:	des
2000-10-17 15:50:22 +00:00
joe
b918a3ad6c Build and install the perl.style(7) manual page. 2000-10-17 15:33:29 +00:00
joe
5798bc3fbd Reclarify variable definition blocks.
Ask programmers to use modules where possible instead of reinventing
  the wheel.
Use 'chomp' not 'chop' please.
Fixup some mdoc.
2000-10-17 15:32:57 +00:00
joe
07afce21e9 An initial draft of a style guide for perl scripts in the tree. 2000-10-17 02:51:03 +00:00
obrien
dfd00c165f Add `isoC-99' to the list of availble abbreviations. 2000-10-11 19:30:41 +00:00
murray
722bd18481 Fix typo : s/maintaince/maintenance/ 2000-10-03 07:38:41 +00:00
phantom
4b6d1d09be Document 'libusb' option for .Lb macro 2000-09-22 14:36:06 +00:00
obrien
93fc8a1033 The kernel is now known as `kernel.ko' and it and its matching modules
live in ``/boot/kernel/''.
2000-09-06 17:51:31 +00:00
green
2a6373ea61 Capitalize the last two entries. Note that i8254 is a timer. Report
that TSC is for any fifth-gneration of later x86 processor, not an
i586, and document that it _is_ available to applications.
2000-07-28 21:48:58 +00:00
mpp
bd6ff3da97 Remove some mis-leading text from the "Libraries" section. 2000-06-24 23:02:01 +00:00
ru
7e5624f6ce Document /usr/lib/aout.
PR:		conf/18167
2000-06-07 07:41:09 +00:00
ru
96199a91ad /usr/mdec has gone 1.5 years ago. 2000-06-05 16:14:51 +00:00
sheldonh
14e9cd73ea Fix miscellaneous mdoc macro argument limit infringements.
PR:		18465
Reported by:	Kazu TAKAMUNE <takamune@avrl.mei.co.jp>
2000-05-09 14:02:06 +00:00
phantom
c7b17c64fe Add libipsec to the list of available libraries 2000-05-04 17:58:22 +00:00
phantom
cbeef441ea Document .Fx', .Nx' and `.Ox' macros as callable and parsable. 2000-05-04 16:25:27 +00:00
phantom
f585d93a0a Add expanded information about .Lb macro 2000-04-23 14:50:38 +00:00
phantom
40d2f93ad8 Add information about newly added .Lb macro 2000-04-23 14:49:22 +00:00
nik
e42546b987 Note that openssh/ssl are in the tree now, and use the correct section
numbers for accton(8), sshd(8), and syslogd(8).

PR:             docs/17100
Submitted by:   Udo Erdelhoff <ue@nathan.ruhr.de>
2000-03-07 13:59:26 +00:00
sheldonh
88dd9b4faa Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
2000-03-03 14:05:08 +00:00
kris
e5a07357d7 Document OpenSSL directories. 2000-01-30 04:22:11 +00:00
chris
d19047f468 Update the /usr/include/ hierarchy for the cam/ and cam/scsi/ directories.
PR:		16345
Submitted by:	Nick Hibma (henny) <n_hibma@webweaving.org>
2000-01-29 06:42:23 +00:00
n_hibma
7d24a31cec Install the USB include files in /usr/include/dev/usb.
We should still sort out some way of avoiding the clutter. Not all files
should be there.

Prompted by:   Louis A. Mamakos <louie@TransSys.COM>
2000-01-25 09:24:23 +00:00
phantom
f370c55053 Fix typos.
PR:		docs/15781
Submitted by:	Christian Weisgerber <naddy@mips.rhein-neckar.de>
2000-01-07 13:20:55 +00:00
itojun
b5c109c129 bring in description for KAME IPv6 changes.
XXX it looks that sysctl.3 lacks most of PF_INET items.
Reviewed by:	shin
Obtained from:	KAME (netbsd-current)
2000-01-06 03:47:57 +00:00
hoek
382369f3fd .Xr pkg_version 1 2000-01-02 17:55:03 +00:00
asmodai
216d01507f Fix some typo's.
PR:		15678
Submitted by:	Christian Weisgerber <naddy@mips.rhein-neckar.de>
1999-12-27 11:02:43 +00:00
dcs
ef74d85fe0 Add /boot. 1999-12-08 22:03:44 +00:00
mpp
8c96c247df Update mdoc(7) and mdoc.samples(7) to list the preferred order
of manual page sections.  Make the two man pages consistent
with each other in the headers they list and they order they list
them in.

Note:  this is the preferred ordering.  All new man pages/additions
to man pages should try and follow this.  Existing man pages
should be left alone, unless you are making major changes  in
the man page and re-ordering of the sections is only a
minor part of the change.

PR:		doc/15352, doc/15353
1999-12-08 21:50:11 +00:00
billf
9e78c04cff A bullet in the head to pkg_manage references. 1999-11-26 22:12:12 +00:00
phantom
e5e36ca825 Fix file names in .FILES section.
Remove reference to obsolete files /us/src/share/tmac/README
1999-11-02 13:47:09 +00:00
phantom
14e33743cf Document .Ox and .Nx macros 1999-11-02 13:27:27 +00:00
phantom
36ba1346ad Document .St macro. 1999-11-02 13:23:56 +00:00
phantom
55078c25fa Fix invalid pathes in FILES section, mdoc(7)'fy 1999-10-30 14:10:31 +00:00
mpp
8371b0134c Correctly escape a macro call in the description of the .D1 macro.
Also use the correct macro (.D1, not .Dl) to format the text,
and in the example output.

PR:		docs/14051
Submitted by:	<andrew@ugh.net.au>
1999-09-30 14:39:22 +00:00
phantom
353c1a6746 Correct spelling : ascii -> ASCII
PR:		docs/13702
Submitted by:	Stephen J. Roznowski <sjr@home.com>
Reviewed by:	mpp
1999-09-20 09:15:23 +00:00
dillon
8969f97c23 Minor cleanups
Reviewed by:	Matthew Dillon <dillon@backplane.com>
Submitted by:	 Alexey Zelkin <phantom@cris.net>
1999-09-19 05:30:12 +00:00
dillon
240736f7b9 Bring security page uptodate, add more references, clarify some of
the comments, etc.
1999-09-18 18:21:38 +00:00
phantom
2bef5edabd Document .Ta macro.
Requested by: ru
Ok'ed by: mpp
1999-09-13 18:58:53 +00:00
phantom
3091f835dc Fix typo: vi(8) -> vi(1)
Noticed by: ru
1999-09-13 18:38:53 +00:00
phantom
77fa618a0b Document .Ox and .Nx macros.
Reviewed by:	mpp
1999-09-13 17:33:16 +00:00
phantom
c3fde8b13c Update to current state of filesystems layout (almost complete)
Stylize

PR:		docs/13229
Reviewed by:	mpp
1999-09-13 17:20:58 +00:00