Commit Graph

1081 Commits

Author SHA1 Message Date
Graham Perrin
2071e54c22 hier(7): alphabetical order
Approved by:  mhorne
Pull request: https://github.com/freebsd/freebsd-src/pull/756
2023-05-30 20:34:18 +01:00
Mike Karels
9a6a948128 hier.7: update /home
The default for home directories is changing from /usr/home to
/home; update the corresponding entries.  Also move /home into
alphabetical order.

Reviewed by:	mhorne, manpages(bcr)
Differential Revision:	https://reviews.freebsd.org/D40203
2023-05-23 07:21:12 -05:00
Warner Losh
4d846d260e spdx: The BSD-2-Clause-FreeBSD identifier is obsolete, drop -FreeBSD
The SPDX folks have obsoleted the BSD-2-Clause-FreeBSD identifier. Catch
up to that fact and revert to their recommended match of BSD-2-Clause.

Discussed with:		pfg
MFC After:		3 days
Sponsored by:		Netflix
2023-05-12 10:44:03 -06:00
Mitchell Horne
031049cf32 hier(7): fix a couple mandoc warnings
These references are rendered correctly without the zero-width space.

MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
2023-05-10 10:26:35 -03:00
Mitchell Horne
36db6b0496 hier(7): document /home/ and /usr/home/
Reviewed by:	imp
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D40002
2023-05-10 10:25:17 -03:00
Mitchell Horne
1bc55f5839 hier(7): drop list of /usr/share/doc subdirectories
Several entries are outdated, several new ones are missing. I do not
think there is much value added in maintaining this.

Reviewed by:	imp, emaste
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D40001
2023-05-10 10:18:21 -03:00
Mitchell Horne
c3b611e153 hier(7): drop list of /usr/include subdirectories
It is nice to have, however, the location of this information means that
it will naturally be missed by developers adding or removing directories
to the layout, so it trends out-of-date and it is out-of-date.

The target audience for hier(7) is users and administrators. It is not
expected to be a place that programmers should go to learn about the
purposes of the different C headers provided by FreeBSD.

Program authors needing FreeBSD-specific interfaces or libraries
(#include <sys/queue.h>, for instance) will either be following a more
detailed man page, or consulting the header contents directly. Folks
targeting standardized headers (#include <sys/time.h>) will not need
hier(7) to tell them where those headers are under /usr/include.

In other words, this is more detail than necessary for this document.
I'd go as far as to say that many of the existing entries in this list
do little more than parrot the name of the directory.

With all this in mind, let's drop the maintenance burden.

Reviewed by:	imp, emaste
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D40000
2023-05-10 10:17:41 -03:00
Ed Maste
fa4651d7ea build.7: remove reference to deprecated mergemaster
Sponsored by:	The FreeBSD Foundation
2023-05-04 21:14:06 -04:00
John Baldwin
e1ff83fb19 arch.7: Bump Dd after removal of riscv64sf.
Pointy hat to:	jhb
2023-04-12 11:35:33 -07:00
John Baldwin
1ca12bd927 Remove the riscv64sf architecture.
Reviewed by:	jrtc27, arichardson, br, kp, imp, emaste
Differential Revision:	https://reviews.freebsd.org/D39496
2023-04-12 11:09:27 -07:00
Mark Johnston
cab1056105 kdb: Modify securelevel policy
Currently, sysctls which enable KDB in some way are flagged with
CTLFLAG_SECURE, meaning that you can't modify them if securelevel > 0.
This is so that KDB cannot be used to lower a running system's
securelevel, see commit 3d7618d8bf.  However, the newer mac_ddb(4)
restricts DDB operations which could be abused to lower securelevel
while retaining some ability to gather useful debugging information.

To enable the use of KDB (specifically, DDB) on systems with a raised
securelevel, change the KDB sysctl policy: rather than relying on
CTLFLAG_SECURE, add a check of the current securelevel to kdb_trap().
If the securelevel is raised, only pass control to the backend if MAC
specifically grants access; otherwise simply check to see if mac_ddb
vetoes the request, as before.

Add a new secure sysctl, debug.kdb.enter_securelevel, to override this
behaviour.  That is, the sysctl lets one enter a KDB backend even with a
raised securelevel, so long as it is set before the securelevel is
raised.

Reviewed by:	mhorne, stevek
MFC after:	1 month
Sponsored by:	Juniper Networks
Sponsored by:	Klara, Inc.
Differential Revision:	https://reviews.freebsd.org/D37122
2023-03-30 10:45:00 -04:00
John Baldwin
6dcd6d199f arch.7: Drop most mentions of MIPS.
Only keep MIPS in the list of deprecated architectures.

Reviewed by:	emaste
Differential Revision:	https://reviews.freebsd.org/D38970
2023-03-08 15:06:47 -08:00
Mark Johnston
96bc40f4df release.7: Correct a variable name
MFC after:	1 week
2023-01-27 14:01:12 -05:00
Mike Karels
7d189f6698 growfs(7): conditionalize mention of adding dump device
The growfs_fstab script will add a new swap partition as a dump
device as well, but only if dumpdev is set to AUTO.

MFC after:	3 days
Reviewed by:	pauamma
Differential Revision:	https://reviews.freebsd.org/D38166
2023-01-23 08:37:07 -06:00
Mike Karels
8664e266d6 growfs(7): clarify assumptions and limitations
Document that the growfs(7) script works only if the root file system
is in the last partition and free space immediately follows it.
Don't imply that /usr can be a separate partition, as that would
likely mean that root is not last.

Reported by:	marklmi at yahoo dot com
2023-01-05 18:44:16 -06:00
Konstantin Belousov
9e0d976d95 sizeof(7): miscellaneous edits
Suggested by:	pstef
Reviewed by:	imp, pstef (previous version)
Sponsored by:	The FreeBSD Foundation
MFC after:	1 week
Differential revision:	https://reviews.freebsd.org/D37683
2022-12-14 07:44:04 +02:00
Jan Schaumann
57bee0817f sizeof(7): remove "All rights reserved"
Requested by:	pstef
MFC after:	1 week
Differential revision:	https://reviews.freebsd.org/D37674
2022-12-14 07:43:04 +02:00
Jan Schaumann
0b75997f4c Add sizeof(7) manual page
PR:	268310
Reviewed by:	kib
Discussed with:	brooks, pauamma
MFC after:	1 week
Differential revision:	https://reviews.freebsd.org/D37674
2022-12-13 06:43:28 +02:00
Mike Karels
4e240e55d8 growfs(7): document addition of swap partition and growfs_fstab script
Add documentation of the growfs script's new ability to add a swap
partition, expanding on the previous functionality as well.  Add the
growfs_fstab helper script, which runs separately.  Add a description
of how to expand a file system a second time if swap had been added.
While here, fix a typo.

Reviewed by:	pauamma
Differential Revision:	https://reviews.freebsd.org/D37465
2022-12-10 13:40:55 -06:00
Pau Amma
88be8b8e54 Fix igor and mandoc -T lint low-hanging fruit in hier(7)
Reviewed by:	danfe, gjb (mentor)

Approved by:	gjb (mentor)

MFC after:	3 days

Differential Revision:	https://reviews.freebsd.org/D37473
2022-11-23 22:40:16 +01:00
Pau Amma
720e0e0ff1 Remove disused /cdrom toplevel dir from hier(7).
Reviewed by:	gjb

Approved by:	gjb (mentor)

MFC after:	3 days

Differential Revision:	https://reviews.freebsd.org/D37472
2022-11-23 22:36:36 +01:00
Gordon Bergling
e0b7defdee orders.7: Sync with NetBSD after CGPM
Extend orders(7) with prefixes from Resolution 3 of
the 27th meeting of CGPM.

Obtained from:	NetBSD
MFC ater:	1 week
2022-11-20 19:24:57 +01:00
Gordon Bergling
b6d1ac7f01 ascii.7: Add full names of the control character set
Extent the manual page by the full names of the
control character set.

Obtained from:	NetBSD
MFC after:	3 days
2022-11-12 12:22:22 +01:00
Mitchell Horne
6028a56562 development(7): redirect users from hier(7)
The layout of the source tree is now only described in README.md. Retain
the cross-reference to hier(7) in SEE ALSO; it is still useful to
readers.

Reviewed by:	imp, emaste
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37136
2022-11-01 12:20:55 -03:00
Mitchell Horne
f0e4e02110 hier(7): remove text describing /usr/src layout
It poses a maintenance burden, since much of the information is
duplicated in the src tree's README.md file. Readers who are interested
enough in learning about the structure of the src tree can download it,
or browse the README online. Have hier(7) just point them there instead.

PR:		261349
Discussed with:	freebsd-arch@, freebsd-doc@ lists
Reviewed by:	imp, emaste
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37135
2022-11-01 12:20:55 -03:00
Mark Johnston
89585511cc release: Add support for creating ZFS-based VM images
The change extends vmimage.subr to handle a new parameter, VMFS, which
should be equal to either "ufs" or "zfs".  When it is set to ZFS, we use
makefs to create a bootable pool populated using the same dataset layout
as bsdinstall and "poudriere image" use.  The pool can be grown using
the growfs rc.d script, just as in UFS images.

This will make it easy to provide VM and cloud images with ZFS as the
root filesystem.  So far I did not do extensive testing of cloud images;
I merely verified that creation of ZFS-based AWS AMIs works and allows
me to create amd64 and arm64 EC2 instances with ZFS as the root
filesystem.

Reviewed by:	emaste, gjb
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D34426
2022-10-28 17:00:24 -04:00
Jose Luis Duran
9871ae6aa9 Track kern.ipc.somaxconn -> kern.ipc.soacceptqueue rename
Fixes:		2bdf61ca29 ("Hide the unfortunate named sysctl...")
MFC after:	3 days
2022-10-11 12:46:46 -04:00
Brooks Davis
b4cfdbfed2 manpages: Remove telnetd references
Mostly remove from the SEE ALSO section, adding a mention of the port
where not removed. Elsewhere, remove as appropriate and change from .Xr
to .Nm where a mention of telnetd continues to make sense (or removing
it would require significant reworking of the surrounding text).

Reviewed by:	imp, delphij, emaste
Differential Revision:	https://reviews.freebsd.org/D36785
2022-09-29 17:56:41 +01:00
Warner Losh
c9baa97471 arch: armv4 isn't supported either on aarch64 running in aarch32 mode
FreeBSD used to support both armv4 and armv5 binaries. All of that
support has been removed from the tree. We have only ever supported
armv6 and armv7 binaries in that mode. Note armv4 here too for
completeness since it flowed better than 'armv5 and earlier' and means
the same thing (FreeBSD never ran on an armv3 or earlier CPU).

Sponsored by:		Netflix
2022-09-15 11:20:01 -06:00
Li-Wen Hsu
2541dcaf44
development(7): Update URLs
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
2022-08-18 09:24:53 +08:00
Jens Schweikhardt
20f68c5f2d Indicate that xrefs to *roff,tbl,eqn et al are found in ports/textproc/groff. 2022-08-15 22:15:18 +02:00
Jens Schweikhardt
825225e52f For man page references found in ports, indicate the respective port. 2022-08-14 15:02:06 +02:00
Mateusz Piotrowski
3c4f8adc79 hier.7: Document /var/db/freebsd-update
MFC after:	3 days
Sponsored by:	Klara, Inc.
2022-08-04 15:58:58 +02:00
Baptiste Daroussin
94778fc738 hier(7): document libdata/pkgconfig 2022-07-25 11:14:50 +02:00
Mateusz Piotrowski
abfa92dee6 development.7: Remove CVS and SVN cross-references
Instead, point to the homepages of the projects.

MFC after:	1 week
2022-07-21 20:35:32 +02:00
Mateusz Piotrowski
d3d6092795 release.7: Remove Subversion references
MFC after:	1 week
2022-07-21 20:25:58 +02:00
Mateusz Piotrowski
6542fd4b95 release.7: Update EMDEDDEDPORTS documentation
EMDEDDEDPORTS does not contain devel/subversion anymore.

Fixes:	a03128832c In extra_chroot_setup(), use 'uname -U' to determine OSVERSION.
MFC after:	1 week
2022-07-21 20:21:44 +02:00
Mateusz Piotrowski
606cdb2ef3 hier.7: Document /nonexistent
MFC after:	1 week
2022-06-30 23:10:28 +02:00
Ed Maste
7fde0187cc Remove "All Rights Reserved" from Foundation copyrights
on man pages.

MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
2022-06-30 10:54:30 -04:00
Mateusz Piotrowski
d5a381f8c7 hier.7: Remove a.out lib directories
Fixes:		76b4234537 BSD.usr.dist: remove aout
MFC after:	1 week
2022-06-30 16:22:02 +02:00
Mateusz Piotrowski
c618ee7277 hier.7: Add some missing Xr's
MFC after:	3 days
2022-06-28 15:20:06 +02:00
Mateusz Piotrowski
bad2f716f4 ftp: Use /var/spool/ftp as ftp's home consistently
The home directory of the ftp user is /var/spool/ftp according to
hier(7). Update the manual page of ftpd(8) to reflect that.

MFC after:	2 weeks
2022-06-28 15:20:05 +02:00
Mateusz Piotrowski
ecd3759719 hier.7: Refer to build(7) for details about /usr/obj
MFC after:	3 days
2022-06-28 15:20:04 +02:00
John-Mark Gurney
50dd2ceaea update command to one that will actually give results
Thanks-to:	kevans@
2022-05-10 20:14:20 -07:00
Mateusz Piotrowski
11a6c85d7f hier: Document /usr/freebsd-dist
/usr/freebsd-dist is used used by various programs as the location for
FreeBSD distribution files. In-tree programs following this convention
are bsdinstall(8) and release(7).

Reviewed by:	Pau Amma <pauamma@gundo.com>
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D34552
2022-03-15 09:54:38 +01:00
Mateusz Piotrowski
5d3007c1a2 stats.7: Fix a typo
MFC after:	3 days
2022-03-04 12:35:55 +01:00
Warner Losh
d0e3860f70 heir: Document SYSROOT conventions
Define a place for sysroot trees to live. This assumes they come from
the base in some way, though there's not yet a build/install/etc sysroot
target. Include the FreeBSD version so multiple verrsions can be
installed on one system (it also includes the whole uname version, so
one could, in theory, install variants like CheriBSD or whatever on the
same system as FreeBSD). Use MACHINE.MACHINE_ARCH to be consistent with
the release practices, /usr/obj and other naming conventions.

Sponsored by:		Netflix
Reviewed by:		brooks
Differential Revision:	https://reviews.freebsd.org/D33754
2022-03-01 17:00:40 -07:00
Christian Brueffer
16ee5cd15a Fix mdoc issues found by mandoc -Tlint. 2022-02-25 17:41:19 +01:00
Warner Losh
3e65b7d94d cleankernel: A target to delete the kernel compile file
With the meta-build, it's always a NO_CLEAN build. Provide a way to
remove so one can rebuild from scratch. 'cleankernel' will delete the
kernel and modules object directories. Document this in build(7).

Sponsored by:		Netflix
Reviewed by:		debdrup, markj
Differential Revision:	https://reviews.freebsd.org/D32978
2022-02-11 12:51:24 -07:00
Mark Johnston
745f30641c release.7: Drop obsolete notes about old versions of mkimg
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
2022-02-08 12:40:41 -05:00