Commit Graph

2550 Commits

Author SHA1 Message Date
trasz
aad01cf5c1 Document EVENTHANDLER_DEFINE(9).
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2017-03-27 20:32:12 +00:00
trasz
e98316cbf4 The cn_consume was removed in r296716.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2017-03-27 20:28:56 +00:00
pluknet
714884b2ca Fix pfil_add_hook() and pfil_remove_hook() type. 2017-03-27 14:32:34 +00:00
rwatson
b7147b1830 Slightly improve consistency of "fooint" vs "foo_int" in DPCPU(9) examples.
MFC after:	3 days
2017-03-26 20:24:27 +00:00
rwatson
0a9cef3867 Add a man page for the kernel's dynamic per-CPU memory allocator.
MFC after: 3 days
2017-03-26 20:15:08 +00:00
ngie
ba0c053962 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
ngie
c9e551899a 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
ngie
8638402b37 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
ngie
963ec5c240 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
ngie
1bc9c52187 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
ngie
1184858ee1 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
ngie
9931e06ead 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
ngie
a19505d2f8 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
ngie
4ec8dbc1a6 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
ngie
d67bd01e7f 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
markj
c4e0ff355e 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
bjk
6c869ffdd6 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
vangyzen
47fc9e6df6 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
ian
15ec52739d Document uiomove_frombuf(9). 2017-03-11 22:22:51 +00:00
jmg
fb27e6a8e4 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
ngie
0408aba5ad 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
scottl
0a68260784 Implement sbuf_prf(), which takes an sbuf and outputs it
to stdout in the non-kernel case and to the console+log
in the kernel case.  For the kernel case it hooks the
putbuf() machinery underneath printf(9) so that the buffer
is written completely atomically and without a copy into
another temporary buffer.  This is useful for fixing
compound console/log messages that become broken and
interleaved when multiple threads are competing for the
console.

Reviewed by:	ken, imp
Sponsored by:	Netflix
2017-02-28 18:25:06 +00:00
imp
36fafdbb83 Remove EISA bus support for add-in cards. Remove related kernel and
compile options. Remove doxygen pointers to now deleted files. Remove
EISA and VME as examples in bus_space.9.

Retained EISA mode code for IO PIC and MPTABLES because that's not
EISA bus, per se, and some people have abused EISA to mean "EISA-like
behavior as opposed to ISA" rather than using it for EISA add-in
cards.

Relnotes: yes
2017-02-16 21:57:35 +00:00
sbruno
8c2c935f91 Add iflib man pages for developers.
Doc review is probably waranted here for editing.

Submitted by:	Nicole Graziano
2017-01-28 00:40:36 +00:00
obrien
fef274c665 Correct grammar. 2017-01-26 16:36:12 +00:00
cem
b2000e56f9 "Buses" is the preferred plural of "bus"
Replace archaic "busses" with modern form "buses."

Intentionally excluded:
* Old/random drivers I didn't recognize
  * Old hardware in general
* Use of "busses" in code as identifiers

No functional change.

http://grammarist.com/spelling/buses-busses/

PR:		216099
Reported by:	bltsrc at mail.ru
Sponsored by:	Dell EMC Isilon
2017-01-15 17:54:01 +00:00
bjk
f915e97cac Fix typo 2017-01-03 21:11:30 +00:00
mjg
510ddab00f Add the upcoming atomic_fcmpset family to the atomic(9) man page.
These primitives give the caller the read value if the exchange attempt
failed which saves an explicit reload for cmpset loops.

The man page was partially submitted by kib.

Reviewed by:	kib (previous version), jhb (previous version)
2017-01-03 20:59:50 +00:00
ed
2e5ad04e96 Add support for attaching aggregation labels to sysctl objects.
I'm currently working on writing a metrics exporter for the Prometheus
monitoring system to provide access to sysctl metrics. Prometheus and
sysctl have some structural differences:

- sysctl is a tree of string component names.
- Prometheus uses a flat namespace for its metrics, but allows you to
  attach labels with values to them, so that you can do aggregation.

An initial version of my exporter simply translated

    hw.acpi.thermal.tz1.temperature

to

    sysctl_hw_acpi_thermal_tz1_temperature_celcius

while we should ideally have

    sysctl_hw_acpi_thermal_temperature_celcius{thermal_zone="tz1"}

allowing you to graph all thermal zones on a system in one go.

The change presented in this commit adds support for accomplishing this,
by providing the ability to attach labels to nodes. In the example I
gave above, the label "thermal_zone" would be attached to "tz1". As this
is a feature that will only be used very rarely, I decided to not change
the KPI too aggressively.

Discussed on:	hackers@
Reviewed by:	cem
Differential Revision:	https://reviews.freebsd.org/D8775
2016-12-14 12:47:34 +00:00
glebius
592e0af9a0 Provide counter_ratecheck(), a MP-friendly substitution to ppsratecheck().
When rated event happens at a very quick rate, the ppsratecheck() is not
only racy, but also becomes a performance bottleneck.

Together with:	rrs, jtl
2016-12-09 17:58:34 +00:00
alc
4343dadb9e The function vm_page_cache() no longer exists. Remove its man page. 2016-11-27 01:44:31 +00:00
brueffer
97d7ab406c Fix various mdoc issues reported by mandoc -Tlint. 2016-11-23 19:19:11 +00:00
alc
85552e2171 Update to reflect the demise of PG_CACHED pages.
Reviewed by:	kib, markj
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D8530
2016-11-16 02:51:24 +00:00
trasz
ebde11fa0f Fix function prototypes in usbdi(9) man page, and tweak it a little.
MFC after:	1 month
2016-11-14 10:41:04 +00:00
andrew
75768c2bf4 Add support for the fpu_kern(9) KPI on arm64. It hooks into the existing
VFP code to store the old context, with lazy loading of the new context
when needed.

FPU_KERN_NOCTX is missing as this is unused in the crypto code this has
been tested with, and I am unsure on the requirements of the UEFI
Runtime Services.

Reviewed by:	kib
Obtained from:	ABT Systeems Ltd
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D8276
2016-10-20 09:22:10 +00:00
avos
40775421e3 mbuf(9), mbuf_tags(9): fix function prototypes.
- Add m_getclr(9) symlink to ObsoleteFiles.inc (removed in r295481).
- Add const qualifiers in m_dup(), m_dup_pkthdr() and m_tag_copy_chain()
(r286450).
- Fix m_dup_pkthdr() definition (it's not the same as m_move_pkthdr()).

MFC after:	5 days
2016-10-10 17:16:02 +00:00
kevlo
5243034a4b Add description for ifi_oqdrops. 2016-10-08 14:58:26 +00:00
bdrewery
612be51044 Add link for vrefl(9).
Sponsored by:	Dell EMC Isilon
MFC after:	1 week
2016-10-06 18:05:25 +00:00
cem
925b70a05d style(9): Some additional clarification
Prompted by an email from bde@.

Reviewed by:	emaste, imp (earlier version)
With input from:	wblock
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D7983
2016-10-06 01:52:00 +00:00
oshogbo
9ebeb4765f Add man page for dnvlist.
Submitted by:	Adam Starak <starak.adam@gmail.com>
Reviewed by:	cem, wblock
2016-10-05 19:01:00 +00:00
hselasky
d04a24c192 Change from passive to active english. Correctly specify that the task
is being drained and not the queue.

Submitted by:	wblock @
MFC after:	3 days
2016-10-03 12:48:55 +00:00
avos
a8662b0cf7 sysctl.9: add missing underscore (SYSCTL_HANDLERARGS -> SYSCTL_HANDLER_ARGS) 2016-09-29 14:14:39 +00:00
hselasky
80e9113ea3 While draining a timeout task prevent the taskqueue_enqueue_timeout()
function from restarting the timer.

Commonly taskqueue_enqueue_timeout() is called from within the task
function itself without any checks for teardown. Then it can happen
the timer stays active after the return of taskqueue_drain_timeout(),
because the timeout and task is drained separately.

This patch factors out the teardown flag into the timeout task itself,
allowing existing code to stay as-is instead of applying a teardown
flag to each and every of the timeout task consumers.

Add assert to taskqueue_drain_timeout() which prevents parallel
execution on the same timeout task.

Update manual page documenting the return value of
taskqueue_enqueue_timeout().

Differential Revision:	https://reviews.freebsd.org/D8012
Reviewed by:	kib, trasz
MFC after:	1 week
2016-09-29 10:38:20 +00:00
kevlo
c3aff0c30a - Prefer if_addrhead (FreeBSD) to if_addrlist (BSD compat) naming for the
interface address list
- Update IFF_RENAMING macro descriptions
2016-09-27 08:47:02 +00:00
gavin
a5566e907a Whitespace commit (literally): Add a missing space.
Sponsored by:	EuroBSDCon 2016 Devsummit, Belgrade, Serbia.
2016-09-22 13:59:27 +00:00
avos
df16410ed5 net80211: remove IEEE80211_RADIOTAP_TSFT field from transmit definitions.
This field may be used for received frames only.

Differential Revision:	https://reviews.freebsd.org/D3826
Differential Revision:	https://reviews.freebsd.org/D3827
2016-09-20 18:53:42 +00:00
imp
96051fb34d Spell alphabetically correctly both in the commit message AND in the
actual man page. Sigh.

Submitted by: David A Bright and Pedro Giffuni
2016-09-20 15:14:33 +00:00
imp
4a97aab6f5 Document existing practice and be more clear about sys/foo.h files
being alphabetical with sys/param.h or sys/types.h being first. Expand
the example to hopefully make this (slightly) clearer.

Noticed by: cem@
2016-09-20 04:50:53 +00:00
jhb
f4f9c5bc8a Make device_quiet() an attachment property.
In particular, reset the DF_QUIET flag when detaching from a device so
that a driver that marks a device quiet doesn't dictate policy for a
different driver that may claim the device in the future.

Reviewed by:	rpokala, wblock
MFC after:	2 weeks
Sponsored by:	Chelsio Communications
Differential Revision:	https://reviews.freebsd.org/D7803
2016-09-12 18:06:42 +00:00
kib
cb80ddd115 Add FPU_KERN_NOCTX flag to the fpu_kern_enter() function on amd64.
The flag specifies that the block which uses FPU must be executed in
critical section, i.e. take no context switches, and does not need an
FPU save area during the execution.

It is intended to be applied around fast and short code pathes where
save area allocation is impossible or undesirable, due to context or
due to the relative cost of calculation vs. allocation.

Sponsored by:	The FreeBSD Foundation
MFC after:	2 weeks
2016-09-11 09:14:07 +00:00