Commit Graph

110 Commits

Author SHA1 Message Date
Christian Brueffer
16ee5cd15a Fix mdoc issues found by mandoc -Tlint. 2022-02-25 17:41:19 +01:00
Baptiste Daroussin
d6ed0d3d31 ports.7: catchup with the package extension name since pkg 1.17
MFC After:	3 days
2021-07-22 10:50:19 +02:00
Li-Wen Hsu
8dfb002457
man7: Update FreeBSD.org URLs
MFC after:	3 days
2021-07-04 22:07:23 +08:00
Fernando Apesteguía
49ddfdec19 ports(7): Add install-missing-packages to target list
It is already used in the EXAMPLES section.

Approved by:	bcr@ (manpages)
Differential Revision: https://reviews.freebsd.org/D30044
2021-06-10 14:58:24 +02:00
Mateusz Piotrowski
d25f7d324a ports.7: Document DEBUG_FLAGS and the process of debugging ports
Loosely based on https://wiki.freebsd.org/BenWoods/DebuggingPorts.

Reviewed by:	crees
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D27296
2021-04-17 22:53:39 +02:00
Mateusz Piotrowski
c0e41dff70 ports.7: Add an example of setting variables for selected ports
Reviewed by:	crees
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D28202
2021-04-17 22:17:38 +02:00
Rene Ladan
11f47f17e1 ports(7): update instructions for git
Reviewed by:	gjb, imp, lwhsu, mat
Differential Revision:	https://reviews.freebsd.org/D29502
2021-04-06 22:26:03 +02:00
Daniel Ebdrup Jensen
248a47a4c2 ports(7): Update instructions for package target
Packages default to ending up in a different location compared to the
documentation, so catch up to the implementation by referring to the
location where packages can usually be found if no environment variables
have been set.

While here, also update the mention of the file extension to match the
txz format that packages use.

PR:		253179, 224370
Reported by:	rwatson, jeromer at fastmail dotnet
2021-02-19 13:42:16 +01:00
Mateusz Piotrowski
ddafd46c88 Do not document MOTIFLIB in ports(7)
Perhaps it made sense in 1998 (r32836), but now it feels a bit out of
place.  We tend to avoid documenting non-essential ports variables in
the manual page (we try to document them in the Porter's Handbook instead).

MFC after:	1 week
2020-11-10 11:32:01 +00:00
Mateusz Piotrowski
23788e6c4a Fix a typo in the description of WITH_DEBUG_PORTS
For each origin listed in WITH_DEBUG_PORTS, the ports framework sets
WITH_DEBUG instead of WITH_DEBUG_PORTS.

MFC after:	3 days
2020-11-03 18:02:02 +00:00
Mateusz Piotrowski
fcdfe01616 Document how to set ports options via make.conf(5)
This patch is based on:
- https://lists.freebsd.org/pipermail/freebsd-ports-announce/2013-June/000062.html
- current content of /usr/ports/Mk/bsd.options.mk

PR:		194306
Reported by:	Daan K. <daanknip__hotmail_com>
MFC after:	2 weeks
2020-11-03 13:26:00 +00:00
Mateusz Piotrowski
758dde0614 Do not document default locations of the OpenBSD and NetBSD ports trees
Our own Ports Collection is not targeting those systems at the moment,
so let's stop documenting bits specific to OpenBSD and NetBSD in the ports
documentation. Especially, that it might bit rot one day.

MFC after:	1 week
2020-11-01 20:54:02 +00:00
Mateusz Piotrowski
76d2af50b5 Document how to use sudo for SU_CMD
It is rather common for the ports users to replace su(1) with sudo(8)
within the SU_CMD variable. Let's document it in the manual page (so far
it's been hidden in a comment within bsd.commands.mk).

MFC after:	2 weeks
2020-11-01 17:27:48 +00:00
Mateusz Piotrowski
8c72577900 Do not mention portsnap(8) in ports.7
As we are moving away from portsnap,
let's not recommend it in the manual page.

Reviewed by:	bcr (manpages), mat (portmgr)
Differential Revision:	https://reviews.freebsd.org/D25847
2020-08-03 13:12:07 +00:00
Piotr Pawel Stefaniak
c6a2e9a7ae Promote use of unprivileged users for building ports by documenting SU_CMD.
Phrasing by Daniel O'Connor.

Reviewed by:	0mp
MFC after:	14 days
Differential Revision:	https://reviews.freebsd.org/D25433
2020-07-17 06:33:20 +00:00
Mateusz Piotrowski
a3f02b1af7 ports.7: Update examples with install-missing-packages
The ports framework recently grew support for installing dependencies with
a dedicated target called "install-missing-packages". Let's retire the
carefully constructed one-liner that was used for getting dependencies so
far and use the official ports target instead.

Reviewed by:	bcr
Approved by:	bcr (mentor)
Differential Revision:	https://reviews.freebsd.org/D23485
2020-02-03 23:40:27 +00:00
Edward Tomasz Napierala
375409b48b .Xr ports(7) and development(7).
MFC after:	2 weeks
2019-08-26 10:16:46 +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
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
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
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
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
Tijl Coosemans
bd5bd02583 Remove deprecated OVERRIDE_LINUX_BASE_PORT. It can be set via
DEFAULT_VERSIONS now (e.g. DEFAULT_VERSIONS+=linux=c7).

Noticed by:	xmj
MFC after:	2 weeks
2017-11-10 11:19:47 +00:00
Eitan Adler
a2aef24aa3 Update several more URLs
- Primarily http -> https
- Primarily FreeBSD project URLs
2017-10-29 08:17:03 +00:00
Edward Tomasz Napierala
225636dccb Fix bunch of .Xrs.
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
2016-03-28 16:48:28 +00:00
Glen Barber
9ef6fea65d Dereference portaudit(1), as it is now deprecated and its
functionality exists in pkg-audit(8).

Submitted by:	Ronald Klop <ronald-lists@klop.ws>
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
2014-06-06 13:36:52 +00:00
Benjamin Kaduk
59be36b0f7 Document some user-settable make variables in ports.7
This is not a comprehensive list, as the variables themselves are spread
out over multiple files, but it is a start.

Add a section to make.conf noting that variables may be set there that
affect ports builds, but refer to ports.7 and elsewhere for the actual
listing; any listing in make.conf.5 would likely become out of date
fairly quickly.

PR:		docs/189199
Reviewed by:	bdrewery (previous version)
Approved by:	hrs (mentor)
2014-05-18 21:05:54 +00:00
Eitan Adler
ae41fe617d Ports switched from dialog to dialog4ports some time ago.
PR:		docs/179785
Repored by:	Kevin Oberman <rkoberman@gmail.com>
Submitted by:	"Ilya A. Arkhipov" <rum1cro@yandex.ru>
MFC After:	3 days
2013-06-20 21:16:46 +00:00
Eitan Adler
7a36e6d2bb Modernize some portions of the ports man page.
Stop documenting other operating systems's default patha

Approved by:	bcr (mentor)
2013-03-04 13:57:46 +00:00
Eitan Adler
481974c226 Modernize parts of the ports.7 manual page.
Approved by:	bcr (mentor)
MFC after:	3 days
2012-11-18 16:34:09 +00:00
Glen Barber
d63559341c Fix date from r231111.
Pointy-hat to:	gjb (myself, approver of r231111)
2012-02-10 03:34:32 +00:00
Eitan Adler
eed1dcab79 ports(7) currently makes no mention of LOCALBASE: fix that
PR:		docs/159551
Submitted by:	Matthew Seaman <m.seaman@infracaninophile.co.uk>
Approved by:	gjb
MFC after:	3 days
2012-02-07 04:00:57 +00:00
Benedict Reuschling
b7642c92bf Add a short description about NO_CHECKSUM.
PR:		docs/155980
Submitted by	KOIE Hidetaka (koie at suri co jp)
MFC after:	7 days
2011-05-30 10:23:59 +00:00
Benedict Reuschling
67900914ff Add a description to the checksum target about not only
being able to verify, but also having the ability to
fetch distfiles that are missing or failed the checksum
calculation

PR:		docs/138887
Submitted by:	Radim Kolar (hsn at sendmail dot cz)
MFC after:	5 days
2011-05-25 08:42:01 +00:00
Giorgos Keramidas
1583221b9d Document TRYBROKEN in ports(7).
PR:		docs/153542
Submitted by:	Eitan Adler <lists@eitanadler.com>
MFC after:	3 days
2011-02-15 07:16:27 +00:00
Thomas Abthorpe
d40caf29b4 - Document targets run-depends-list and build-depends-list
PR:		docs/127575
Submitted by:	Walter Venable <walt relnor.com>
Approved by:	keramida
MFC after:	3 days
2009-01-21 21:29:00 +00:00
Jens Schweikhardt
f283c8f8fc Correct a typo. 2008-12-05 22:04:52 +00:00
Tom Rhodes
039b8701cf The config-recursive target is not run during the normal install process, move
it down to where it belongs.

Document 'all-depends-list' target and bump doc date.

PR:		119519
Submitted by:	Yuri Pankov <yuri.pankov@gmail.com>
Reviewed by:	flz
2008-01-22 12:23:30 +00:00
Christian Brueffer
724c0a230e Document the 'maintainer' target.
PR:		119699
Submitted by:	Warren Block <wblock@wonkity.com>
MFC after:	3 days
2008-01-21 19:52:15 +00:00
Gabor Kovesdan
d5d75e69bd - Remove incomplete sentence fragment
PR:		docs/117451
Submitted by:	Warren Block <wblock@wonkity.com>
MFC after:	3 days
2007-12-21 21:48:54 +00:00
Gabor Kovesdan
520a4bfde7 - Document PORT_DBDIR
PR:		docs/114731
Submitted by:	Matthew Seaman <m.seaman@infracaninophile.co.uk>
2007-12-21 21:44:33 +00:00
Gabor Kovesdan
1ea65ec729 - Document icase variable of make search, which can be used to control
case-sensitivity

PR:		docs/117593
Submitted by:	Nikolay Bachiyski <nbachiyski@developer.bg>
2007-12-21 21:32:12 +00:00
Gabor Kovesdan
a02c85c136 - Fix origin of the portcheckout port as we have it in the port-mgmt
category now

PR:		docs/115193
Submitted by:	Tomas Mozes <hydrapolic at gmail dot com>
Approved by:	re (bmah),
		keramida (mentor)
MFC after:	0 days
2007-08-22 18:07:41 +00:00