Commit Graph

894 Commits

Author SHA1 Message Date
Emmanuel Vadot
1d6d0a43ce pkgbase: move man pages from runtime-manual to runtime
We don't split the other man pages in their own package so do the same for runtime.

Reviewed by:	bapt, gjb
Differential Revision:	https://reviews.freebsd.org/D20962
2019-07-19 15:12:20 +00:00
Edward Tomasz Napierala
1cedef8f7f Make tests(7) point people at the atf(7) man page.
Other frameworks, such as googletest, should be added there as well,
once they become viable.  For now let's keep it simple.

Discussed with: ngie, emaste
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D20124
2019-06-02 16:33:24 +00:00
Edward Tomasz Napierala
f41ad4eaa7 The "apropos ''" command no longer works; change development(7)
to suggest "apropos ." instead.

MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2019-05-16 09:49:19 +00:00
Edward Tomasz Napierala
7e89a7e343 Remove trailing slashes from URLs; current mandoc(1) seems to render
them just fine.

MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2019-05-01 13:00:33 +00:00
Edward Tomasz Napierala
1842b0778b Remove spurious comma.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2019-04-09 10:17:24 +00:00
Mateusz Piotrowski
96fdbc90b2 ports.7: Add an example of how to use flavors
At the moment the manual page is not documenting how to build
a flavored package. Let's start documenting flavors with
an example of a typical use case.

Reported by:	cem, dim
Reviewed by:	bcr, cem, mat, matthew
Approved by:	cem (src)
Differential Revision:	https://reviews.freebsd.org/D19531
2019-03-12 09:27:37 +00:00
Edward Tomasz Napierala
240d69b9b4 Fix markup - use .Pa for the directory component, not .Fa.
Reported by:	0mp
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2019-02-12 13:01:55 +00:00
Edward Tomasz Napierala
22427daf7e Add explanation of branches to the ports(7) man page.
Reviewed by:	matthew@, freebsd@mhka.no
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D19146
2019-02-11 20:46:32 +00:00
Mateusz Piotrowski
af1f5e647a ports.7: Do not mention deprecated WITH_SSP_PORTS and WITH_GHOSTSCRIPT_VER
As mentioned in this special status report[1] from EuroBSDCon 2013,
WITH_SSP_PORTS was relevant in the FreeBSD 9 and FreeBSD 10 days.
Nowadays, -fstack-protector is set by default. Relevant knobs and variables
are documented in ports/Mk/bsd.port.mk.

WITH_GHOSTSCRIPT_VER was part of USE_GHOSTSCRIPT, which is deprecated.

[1]: https://www.freebsd.org/news/status/report-2013-09-devsummit.html#Ports-and-Packages

Reviewed by:	bcr, mat, tobik
Approved by:	bcr (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18056
2019-01-08 09:41:52 +00:00
Mateusz Piotrowski
154b4d392c ports.7: Add an example of getting dependencies without building them
While here, improve formatting of the EXAMPLES section in general.

Reviewed by:	bcr
Approved by:	bcr (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18682
2018-12-30 00:27:28 +00:00
Warner Losh
228c425533 Dynamically load .so modules to expand functionality
o Dynamically load all the .so files found in /libexec/nvmecontrol and
  /usr/local/libexec/nvmecontrol.
o Link nvmecontrol -rdynamic so that its symbols are visible to the
  libraries we load.
o Create concatinated linker sets that we dynamically expand.
o Add the linked-in top and logpage linker sets to the mirrors for them
  and add those sets to the mirrors when we load a new .so.
o Add some macros to help hide the names of the linker sets.
o Update the man page.

Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D18455

fold
2018-12-06 22:58:26 +00:00
Ed Maste
407345752d hier.7: add /lib/casper directory
Reported by:	imp
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
2018-12-06 21:27:36 +00:00
Edward Tomasz Napierala
a3c733b261 Add examples for "make buildenv".
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-12-06 13:52:02 +00:00
Edward Tomasz Napierala
ecc0f5f63b Use less misleading directory name.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-12-03 13:15:54 +00:00
Edward Tomasz Napierala
5167a1a737 Silence down the example builds a bit.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 16:02:27 +00:00
Edward Tomasz Napierala
f1d1d6f66e Add an example of quick kernel rebuild.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 16:01:43 +00:00
Edward Tomasz Napierala
873a1193b7 Add an example of rebuilding a single piece of userspace.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 15:56:14 +00:00
Mateusz Piotrowski
0a05369d45 ports(7): Do not mention deprecated WITH_OPENSSL_PORT.
Reviewed by:	eadler
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18045
2018-11-20 10:01:56 +00:00
Mateusz Piotrowski
03840eefd7 development(7): Replace "reboot" with "shutdown -r now"
We generally document shutdown(8) instead of reboot(8) as it's better for
interactive use.

In modern FreeBSD is matters a lot less, it's mostly just convention. One
minor thing is that shutdown(8) produces a global message, while reboot(8)
does not. It is believed that historically, some versions of reboot did not
do appropriate safe shutdown checks and just rebooted.

It's also just consistency: for example the handbook[1] documents shutdown.

There is actually another important difference between reboot and shutdown
-r now: reboot does not run /etc/rc.shutdown. This is because reboot has
its own shutdown procedure and does not signal init like init 6 and
shutdown -r now do (except in the case of rerooting via reboot -r).

A few years ago jilles@ proposed changing reboot's default to signalling
init (preserving reboot -q which just invokes the reboot system call), but
this was not accepted. Perhaps this can be tried again for 13.0.

[1]: https://www.freebsd.org/doc/handbook/boot-shutdown.html

Reported by:	eadler
Reviewed by:	eadler, jilles
Approved by:	krion (mentor)
Differential Revision:	https://reviews.freebsd.org/D16843
2018-11-16 14:29:28 +00:00
Ed Maste
4a23879502 build(7): clarify buildenv target can be used for non-cross builds
make buildenv can be used for building for the same architecture as
the host (perhaps this is a degenerate case of cross-building).
TARGET and TARGET_ARCH do not need to be set in this case.

Reviewed by:	bdrewery
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D10759
2018-11-10 20:26:19 +00:00
Ed Maste
1f3de6dce9 arch.7: update final ia64 release to 10.4
No more 10.x releases are planned.
2018-10-23 13:03:24 +00:00
Ed Maste
2af3ea6bc1 arch.7: first appeared in FreeBSD 11.1 2018-10-22 18:41:22 +00:00
Mateusz Piotrowski
2bd42f2f4d Suggest to reboot after installworld in the example of development workflow.
Reviewed by:	trasz
Approved by:	mat (mentor)
Differential Revision:	https://reviews.freebsd.org/D16746
2018-08-22 13:25:41 +00:00
Warner Losh
01012c6442 Document LOADER_DEFAULT_INTERP.
This controls what interpreter the default boot loader in
/boot/loader{,.efi} is, and which one we compile into userboot by
default.
2018-08-19 10:15:28 +00:00
Kyle Evans
4b2cc4d121 build(7): Document KERNCONFDIR - directory in which KERNCONF resides
MFC after:	1 week
2018-08-16 13:42:08 +00:00
Mateusz Piotrowski
3d04377b2f Tidy up the ports.7 manual page.
- Use "Dq Li" for inline commands as we do in other manuals.
  - Pet "igor" and "mandoc -Tlint".
  - Reword some parts for clarity.
  - Add missing Xr macros.
  - Reformat SEE ALSO to make the section more readable.

Reviewed by:	eadler, krion, mat
Approved by:	krion (mentor), mat (mentor)
Differential Revision:	https://reviews.freebsd.org/D15350
2018-08-16 13:29:23 +00:00
Alexander Leidinger
c046b2a9e0 Add svnlite to places where svn is mentioned.
The Makefile part in the PR is solved already differently, so this
part is skipped form the PR The man page change change is slightly
changed to adapt to the way the Makefile works and to the spirit
of what is intended here.

Submitted by:	Juan Ramón Molina Menor <info@juanmolina.eu>
PR:		194910
Sponsored by:	Essen Hackathon
2018-08-11 13:18:19 +00:00
Ian Lepore
f38b2297a3 Document 64-bit arm in terms of arch name (aarch64) not machine (arm64).
Other architectures are documented in terms of the name that is displayed by
'uname -p', aka MACHINE_ARCH and TARGET_ARCH in the build system, now
aarch64 matches the rest of them.

PR:		220297
2018-08-05 22:24:38 +00:00
Eitan Adler
33f4bccaa6 Use https over http for FreeBSD pages 2018-07-27 10:40:48 +00:00
Ed Maste
83722abcb6 arch.7: fix whitespace from r336435
Previously armeb's Final Release rendered as 'Ta 11.x'.

Sponsored by:	The FreeBSD Foundation
2018-07-23 21:09:57 +00:00
Ed Maste
f84d8f0ce5 arch.7: Clarify architecture-specific macro use
Compilers may define multiple variants of architecture-specific macros
(for example, both __x86_64 and __x86_64__).  Add a note that the macros
documented in arch.7 are the preferred ones for FreeBSD.

Sponsored by:	The FreeBSD Foundation
2018-07-23 19:39:20 +00:00
Warner Losh
e9d6b13d25 Remove armeb from arch.7
Remove all the details about armeb from arch(7), except for its
release start and end, like alpha, ia64 and pc98.

Differential Revision:  https://reviews.freebsd.org/D16257
2018-07-17 23:23:39 +00:00
Edward Tomasz Napierala
f1dd498487 Tweak ports(7) manual page to better explain the basics.
Reviewed by:	allanjude@ (earlier version)
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D16149
2018-07-11 13:53:44 +00:00
Edward Tomasz Napierala
4a7ec940e4 Fix mandoc -Tlint warning introduced in r335977.
Reported by:	0mp@
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-07-05 11:50:59 +00:00
Edward Tomasz Napierala
1b3fba16da Add trivial usage example to ports(7).
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-07-05 11:03:11 +00:00
Edward Tomasz Napierala
b920f69bd0 "Kernel APIs" is a misnomer; use the proper name instead.
Suggested by:	kib@, ian@
MFC after:	2 weeks
2018-06-21 08:19:11 +00:00
Edward Tomasz Napierala
4c156ba299 Improve wording.
MFC after:	2 weeks
2018-06-20 19:16:51 +00:00
Edward Tomasz Napierala
8a1500e525 Improve spelling and capitalize "Kerberos".
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-06-18 13:49:44 +00:00
Edward Tomasz Napierala
86b83608d8 Mention that ports are used to build packages, this fact - obvious
to the developers, but much less so to users - seems to be rather
weakly documented.

MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-06-13 18:50:51 +00:00
Edward Tomasz Napierala
8f9c737173 Get rid of references to /usr/share/doc/ from ports(7) and getosreldate(3).
The handbooks are not installed there anymore. While here, improve the
URLs markup a bit.

Reviewed by:	allanjude@
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D15793
2018-06-13 18:34:49 +00:00
Eitan Adler
6930346f0f my copyright: some minor adjustments
- remove "all rights reserved" from my copyright on my extensive
  contributions
- belatedly add my name to tuning.7 which I was a large contributor to
  several years ago

This commit can also serve as implicit permission for any formatting or
non-substantive changes that FreeBSD wishes to make in the future.
2018-05-19 20:35:15 +00:00
Edward Tomasz Napierala
5596cb9463 Improve development(7):
- Use Fx when referring to FreeBSD.
 - Use Ql instead of Cm for command invocations.
 - Remove some redundant Pp macros.
 - Use a literal indented Bd instead of a series of Dl macros.

Submitted by:	0mp@
Reviewed by:	eadler@
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D15126
2018-05-11 15:11:53 +00:00
Edward Tomasz Napierala
604f1c416c Don't put multiple names on a single .Nm line. This fixes apropos(1)
output, from this:

strnlen, strlen, strlen,(3) - find length of string                                                                                                                                                     │·······

... to this:

strlen, strnlen(3) - find length of string

PR:		223525
MFC after:	2 weeks
2018-04-17 09:05:46 +00:00
Edward Tomasz Napierala
9c08ba7704 Make development(7) mention tests and section 9 of manual pages.
MFC after:	2 weeks
2018-04-10 08:01:55 +00:00
Edward Tomasz Napierala
01a57e8a84 Bring some order to horizontal and vertical spacing in hier(7).
MFC after:	2 weeks
2018-04-02 21:33:16 +00:00
Glen Barber
0e976a76ff Add an example for building SD card images for the RPI-B and
RPI3.

MFC after:	3 days
Suggested by:	Arshan Khanifar
Reviewed by:	Arshan Khanifar <arshan@freebsdfoundation.org>
Sponsored by:	The FreeBSD Foundation
2018-03-28 18:43:06 +00:00
Glen Barber
a8233b81c7 Update the Release Engineering article URL to the modern version.
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
2018-03-28 18:28:27 +00:00
Edward Tomasz Napierala
ac663598df Add trailing slash for consistency.
For some reason, the other link - https://lists.FreeBSD.org/ - needs
the trailing slash, otherwise man(8) renders it in a weird way.  No
idea why's that.  At least try to be consistent.  Revert it when the
other link gets fixed.

MFC after:	2 weeks
2018-03-27 14:54:02 +00:00
Edward Tomasz Napierala
f9b7620b3e Use https:// instead of http://.
MFC after:	2 weeks
2018-03-27 14:51:19 +00:00
Edward Tomasz Napierala
f007c46d25 Fix capitalization.
MFC after:	2 weeks
2018-03-27 14:50:12 +00:00