Commit Graph

10421 Commits

Author SHA1 Message Date
Enji Cooper
fa5045467b Try polishing up iflib manpages a bit (basically all the low hanging fruit)
igor:
- Fix typos.
- Delete trailing whitespace.

manlint:
- Use .Fo/.Fc/.Fa when describing functions.
- Use .Xr.
- Fill in SEE ALSO section.
- Fix .Dt use: the section was specified incorrectly and the name
  had a lowercase character.
- Continue new sentences on new lines.

Miscellaneous:
- Remove unnecessary quotes around "SEE ALSO" section headers.
- Sprinkle .Dv use in spots with constants.

Reported by:	igor, make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 07:36:38 +00:00
Enji Cooper
2958b3a40c PCI_IOV_*INIT(9): fix make manlint warnings
Add missing section number when referring to PCI_IOV_*INIT(9) with .Xr
from the other corresponding manpage.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 06:11:31 +00:00
Enji Cooper
02e7c2cbab memguard(9): fix igor/manlint warnings
- Expand a contraction [1].
- Add a missing section number when referring to uma(9) with .Xr .

MFC after:	1 week
Reported by:	igor [1], make manlint [2]
Sponsored by:	Dell EMC Isilon
2017-03-23 06:08:01 +00:00
Enji Cooper
114af3cd74 ifnet(9): fix some igor/manlint warnings
- Fix typos (queueing -> queuing) [1].
- Add missing section number for polling .Xr reference [2].

MFC after:	1 week
Reported by:	igor [1], make manlint [2]
Sponsored by:	Dell EMC Isilon
2017-03-23 06:02:23 +00:00
Enji Cooper
054cb42fff dnv(9): fix use of commas with .Nm in NAME section
MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:54:07 +00:00
Enji Cooper
640ca09ddb counter(9): fix igor/manlint warnings
- Reword description of `counter_enter` slightly to fix
  wordiness [1].
- Expand "isn't" as "is not" [1].
- Add missing section number with .Xr sysctl calls [2].

MFC after:	1 week
Reported by:	igor [1], make manlint [2]
Sponsored by:	Dell EMC Isilon
2017-03-23 05:51:54 +00:00
Enji Cooper
70284f8553 DB_COMMAND(9): fix mandoc markup
Start new sentences on new lines.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:44:18 +00:00
Enji Cooper
df3d220fc5 buf_ring(9): fix mandoc markup
Remove spurious trailing comma after `buf_ring_peek` in the NAME
section.

MFC after:	1 week
Sponsored by:	Dell EMC Isilon
2017-03-23 05:41:56 +00:00
Enji Cooper
7eadf51252 bus_alloc_resource(9): fix mandoc markup
Add missing comma after `.Nm bus_alloc_resource_any` in NAME section.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:38:57 +00:00
Enji Cooper
445deb63de alq(9): fix mandoc markup
Start new sentence on a new line.

MFC after:	1 week
Sponsored by:	Dell EMC Isilon
2017-03-23 05:37:04 +00:00
Enji Cooper
3bbc702ffb intro(3): fix markup
- Use `Em` with `.It` macro when referring to other libraries, instead of
  `Xr`.
- Use `.Em` instead of `.Xr` when referring to libraries.
- Remove commented out lines.

MFC after:	1 month
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:26:44 +00:00
Enji Cooper
fcf7a53cea tuning(7): fix SEE ALSO section sorting
dummynet(4) should come before eventtimers(4)

MFC after:	1 week
Sponsored by:	Dell EMC Isilon
2017-03-23 05:15:35 +00:00
Enji Cooper
8fea68c6a6 tests(7): fix mdoc warning
Continue sentence in "Configuring the tests" on a new line.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:12:07 +00:00
Enji Cooper
53837b18b6 build(7): sort SEE ALSO section
tests(7) should be grouped in the man section 7 group, not the section 8 group.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 05:06:40 +00:00
Enji Cooper
acc3e91350 Add a post-humous manpage for cd9660(5), the ISO-9660 file system
Describe (briefly) how to compile the filesystem into the kernel and
load as a module.

Reference cd9660(5) in mount(8) and mount_cd9660(8).

MFC after:	1 month
Sponsored by:	Dell EMC Isilon
2017-03-23 02:57:08 +00:00
Enji Cooper
5dd71be557 tmpfs(5): fix mdoc warnings
- Delete trailing whitespace
- Sort SEE ALSO order: mmap(2)'s Xr should come before nmount(2)'s Xr.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-23 02:33:27 +00:00
Enji Cooper
a121d3a8dc Regenerate src.conf(5) (again)
Sponsored by:	Dell EMC Isilon
2017-03-23 02:29:59 +00:00
Enji Cooper
8834213466 Regenerate src.conf(5)
Sponsored by:	Dell EMC Isilon
2017-03-23 02:21:59 +00:00
Enji Cooper
b6db9b8438 rc.conf(5): fix a .Xr call for chroot(8)
Add the missing section number to the .Xr call.

MFC after:	1 week
Sponsored by:	Dell EMC Isilon
2017-03-23 01:16:26 +00:00
Enji Cooper
7ce037341c Commit Makefiles changes not build manpage for igb(4), accidentally
forgotten in r315742.

X-MFC with:	r311849, r315742
Pointyhat to:	ngie
Sponsored by:	Dell EMC Isilon
2017-03-22 21:39:00 +00:00
Enji Cooper
67d01c2bab Merge documentation for em(4) and igb(4)
Document work done by mmacy/sbruno to merge the two drivers together
and convert em(4) to the iflib framework.

X-MFC with:	r311849
Sponsored by:	Dell EMC Isilon
2017-03-22 21:32:44 +00:00
Mark Johnston
3d6732549d Add support for 8- and 16-bit atomic_(f)cmpset to x86.
Reviewed by:	kib
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D10068
2017-03-22 17:29:04 +00:00
Xin LI
c6209be8ef Pet manlint.
MFC after:	2 weeks
2017-03-20 04:41:36 +00:00
Edward Tomasz Napierala
8a022b97a8 Bring back the "i". The point is to make it easy to find via "apropos
iscsi", along with all the other relevant components.

MFC after:	2 weeks
2017-03-19 15:53:17 +00:00
Benjamin Kaduk
2e17a50f83 Tidy up mdoc formatting for "etc.)" at end of line
man(1) has some logic to use two spaces after a full stop, which is
useful for spotting sentence breaks in monospace fonts.  However,
this logic is very simple, treating almost all '.' characters as
end-of-sentence markers, unless followed by certain other
characters.  For example, '.,' is not end-of-sentence, and neither
is ".) ", but ".)" at the end of a line triggers the sentence-end
detection.

Apply a zero-width space to a few instances of this in share/man,
and also supply a missing full stop for an instance that occurred at
the end of a sentence.

Leave untouched several instances that are at the end of a sentence
or list element.

Reported by:	0mp (ieee80211.9)
2017-03-19 01:24:18 +00:00
Eric van Gyzen
3f8455b090 Add clock_nanosleep()
Add a clock_nanosleep() syscall, as specified by POSIX.
Make nanosleep() a wrapper around it.

Attach the clock_nanosleep test from NetBSD. Adjust it for the
FreeBSD behavior of updating rmtp only when interrupted by a signal.
I believe this to be POSIX-compliant, since POSIX mentions the rmtp
parameter only in the paragraph about EINTR. This is also what
Linux does. (NetBSD updates rmtp unconditionally.)

Copy the whole nanosleep.2 man page from NetBSD because it is complete
and closely resembles the POSIX description. Edit, polish, and reword it
a bit, being sure to keep any relevant text from the FreeBSD page.

Reviewed by:	kib, ngie, jilles
MFC after:	3 weeks
Relnotes:	yes
Sponsored by:	Dell EMC
Differential Revision:	https://reviews.freebsd.org/D10020
2017-03-19 00:51:12 +00:00
Justin Hibbits
b619f389ad Update dtsec man page with correct config requirements. 2017-03-17 03:14:15 +00:00
Eric van Gyzen
8addc72b3e Add missing pieces of r315280
I moved this branch from github to a private server, and pulled from the
wrong one when committing r315280, so I failed to include two recent commits.
Thankfully, they were only cosmetic and were included in the review.
Specifically:

Add documentation, polish comments, and improve style(9).

Tested by:	pho (r315280)
MFC after:	2 weeks
Sponsored by:	Dell EMC
Differential Revision:	https://reviews.freebsd.org/D9791
2017-03-14 22:02:02 +00:00
Bryan Drewery
bba279e552 hier(7): Fix entry location for /usr/share/vt.
MFC after:	2 weeks
2017-03-13 19:54:20 +00:00
Alexander Motin
2b665a98b5 Some more polishing.
MFC after:	13 days
2017-03-12 12:38:16 +00:00
Ian Lepore
1ba0d51a7b Document uiomove_frombuf(9). 2017-03-11 22:22:51 +00:00
Alexander Motin
277681e109 Improve ctl(4) description, including frontends and backends.
MFC after:	2 weeks
2017-03-11 20:23:05 +00:00
Baptiste Daroussin
65f536f1dc Regenerate after r315057 2017-03-11 06:58:28 +00:00
Jeremie Le Hen
fde6665233 Add a very natural, binary version of the ASCII table.
Reviewed by:	bcr, eadler
Obtained from:	https://garbagecollected.org/2017/01/31/four-column-ascii/
MFC after:	1 day
Differential Revision:	https://reviews.freebsd.org/D9902
2017-03-10 09:58:10 +00:00
Alan Somers
312227566c Slight rewording in nvme(4)
Reviewed by:	jimharris, imp
MFC after:	3 weeks
Differential Revision:	https://reviews.freebsd.org/D9927
2017-03-09 05:30:05 +00:00
Baptiste Daroussin
45fca29bc5 Remove reference to GNU info hier(7)
we have removed texinfo in FreeBSD 11.0
2017-03-08 08:57:35 +00:00
Ermal Luçi
dce33a45c9 The patch provides the same socket option as Linux IP_ORIGDSTADDR.
Unfortunately they will have different integer value due to Linux value being already assigned in FreeBSD.

The patch is similar to IP_RECVDSTADDR but also provides the destination port value to the application.

This allows/improves implementation of transparent proxies on UDP sockets due to having the whole information on forwarded packets.

Reviewed by:	adrian, aw
Approved by:	ae (mentor)
Sponsored by:	rsync.net
Differential Revision:	D9235
2017-03-06 04:01:58 +00:00
John-Mark Gurney
dac42e98ee add missing MLINKS for functions that this man page documents.
This page should be renamed to eliminate an unneeded inode.

Forgotten by: markm
2017-03-05 18:37:25 +00:00
Eitan Adler
95f289d5ea remove the the duplicate words from share/ 2017-03-05 18:00:52 +00:00
Rodney W. Grimes
a45dc64252 Document 3 more src/ directories
Approved by:	grehan(mentor)
MFC after:	1 week
Verified by:	igor (same errors before and after)
2017-03-05 03:58:57 +00:00
Eric Badger
99b14d9f1b remove procfs ctl interface
This interface has no in-tree consumers and has been more or less
non-functional for several releases.

Remove manpage note that the procfs special file 'mem' is grouped to
kmem. This hasn't been true since r81107.

Remove procfs' README file. It is an out of date duplication of the manpage
(quoth the README: "since the bsd kernel is single-processor...").

Reviewed by:	vangyzen, bcr (manpage)
Approved by:	des (procfs maintainer), vangyzen (mentor)
Differential Revision:	https://reviews.freebsd.org/D9802
2017-03-05 03:05:24 +00:00
Enji Cooper
e44885ac01 share: normalize paths using SRCTOP-relative paths or :H when possible
This simplifies make logic/output

MFC after:	1 month
Sponsored by:	Dell EMC Isilon
2017-03-04 11:26:40 +00:00
Enji Cooper
12edba1ef1 Clean up ddb(4) slightly
- Delete empty Li macro uses [1]. This removes some spaces between
  the optional command/subcommand arguments.
- Attempt to clarify "show lock" subcommand by being more
  terse/direct. This addresses an issue with a contraction [2].

MFC after:	1 week
Reported by:	make manlint [1], igor [2]
Reviewed by:	wblock
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D9858
2017-03-03 18:44:20 +00:00
Ed Maste
1df22ae01f regen src.conf.5 for clang-4.0.0 merge
Note that makeman's use of 'make showconfig' interacts poorly with
the COMPILER_FEATURES test in share/mk/src.opts.mk, because it tests the
host compiler, not the bootstrap compiler that will actually be used to
build world. This causes it to report that Clang is enabled by default
on MIPS and PowerPC.

For example:
% make TARGET_ARCH=mips64 showconfig | grep CLANG
MK_CLANG         = yes
MK_CLANG_BOOTSTRAP = no
MK_CLANG_EXTRAS  = no
MK_CLANG_FULL    = yes
MK_CLANG_IS_CC   = no

I am committing this version anyway to avoid extraneous diffs in
src.conf.5 after every other WITH_/WITHOUT_FOO change.

In addition, we intend to switch to a C++11 compiler for all archs for
12.0 (either by fixing Clang for those archs, or by requiring an
external toolchain), and then src.conf.5 will be correct.

Sponsored by:	The FreeBSD Foundation
2017-03-03 16:07:46 +00:00
Navdeep Parhar
9cf7698330 Regen src.conf.5 after r314579.
Sponsored by:	Chelsio Communications
2017-03-03 15:47:50 +00:00
Enji Cooper
fa42250152 Correct MLINKS for sbuf_hexdump(9)
sbuf_hexdump(9) should be linked to sbuf(9), not hexdump(3). Another
review will be posted to deduplicate the sbuf_hexdump reference in
in hexdump(3) or at the very least make the information less duplicative.

MFC after:	1 week
X-MFC with:	r313437
Sponsored by:	Dell EMC Isilon
2017-03-03 06:31:47 +00:00
Enji Cooper
3f879a470b Clean up netmap(4) slightly
- Add missing sections for .Xr references.
- Replace .br with .Pp (the former macro is deprecated).
- Use the .Sx (section reference) macro when referring to
  LIBRARIES, not the .Xr (cross-reference) macro.
- Add commas after "e.g." and "i.e." [*].

Bump .Dd for the change

Approved by:	luigi
MFC after:	1 week
Reported by:	igor [*], make manlint
Sponsored by:	Dell EMC Isilon
Differential Revision:	D9859
2017-03-03 06:18:47 +00:00
Enji Cooper
e51c23d9fb Wordsmith mlx4{en,ib}(4)
- Replace the "following lines" with more terse phrases.
- Use .Lk for the mellanox URL.
- Reword the SUPPORT section so it's less wordy.

The DESCRIPTION section suggestions are still outstanding; improving
the section requires additional review to make sure the nuance/message
is correct per the original intent.

Bump .Dd for the change

Submitted by:	wblock
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D9241
2017-03-02 06:57:13 +00:00
Enji Cooper
c907245759 Add missing section to .Xr macro calls for wpifw(4)
The driver manpage for wpifw(4) is missing, but will be added soon. This
fixes the other 2 .Xr calls lacking sections to match the 3rd,
syntactically correct, reference in the SEE ALSO section.

MFC after:	1 week
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-02 06:25:50 +00:00
Enji Cooper
906671dbd4 Sort .Xr: ahci(4) comes before ahd(4)
X-MFC with:	r314110
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
2017-03-02 06:22:05 +00:00