Commit graph

896 commits

Author SHA1 Message Date
gdt
b2029f2122 guide: Note that "make regen" will commit the new versions
It seemed obvious to me that regen would create the files, so they
could be reviewed, and that one would then commit them manually.  Warn
the next person...
2021-03-26 17:44:56 +00:00
gdt
d20e4a1e22 guide: Modernize MESSAGE section
Based on tech-pkg traffic over the last few years that appears to have
rough consensus, adjust MESSAGE section to explain that it should only
be used for exceptional circumstances, and specifically not to
substitute for documentation that belongs in the package's docdir.
2021-03-26 17:43:20 +00:00
dbj
f2e8a003f2 doc/guide: fix name of PKGSRC_KEEP_BIN_PKGS var 2021-02-06 15:21:49 +00:00
leot
7bbbf68ec4 doc/guide: Update htdocs-share to 20210110 (pkgsrc-2020Q4) 2021-01-10 14:50:06 +00:00
jnemeth
b286ce95c7 Welcome to 2021! 2021-01-02 08:32:15 +00:00
fcambus
564d868e07 doc/guide: fix a couple of typos in the .xml files. 2020-12-12 21:45:41 +00:00
leot
bf50e38a86 doc/guide: Update htdocs-share to 20201009 (pkgsrc-2020Q3) 2020-10-09 15:50:34 +00:00
kim
af0dc62f19 New htdocs-share-20200903.tar.gz 2020-09-03 14:57:39 +00:00
bacon
19ab68da85 buildlink.xml: Document new PREFER_PKGSRC=yes default for Linux
Also document new boostrap --prefer-native flag and clarify dangers of
changing PREFER_* after bootstrap
2020-08-20 13:31:58 +00:00
schmonz
1c67cac0f6 Follow rename to bootstrap/README.macOS. 2020-08-14 07:40:51 +00:00
bacon
dd44371ebb editing.xml: Update guide editing procedure
Indicate the need for the htdocs repo as a sibling to pkgsrc for bmake regen
2020-08-12 14:40:33 +00:00
bacon
e8af7192f7 fixes.html: Expand Github versioning guide
Split section on Github commits into two:

1. Commits before the first release (recommend 0.0.0.N)
2. Commits between releases (use git describe --tags)

Also clean up indentation and remove zero-width space chars that were not
rendering properly.
2020-08-11 20:32:58 +00:00
leot
53b97fc566 doc/guide: Update htdocs-share to 20200704 (pkgsrc-2020Q2) 2020-07-04 19:43:19 +00:00
rillig
2eba7ebdad doc/guide: remove outdated patches
As of today, the DocBook processing in htdocs generates the PDF directly
as well.
2020-06-21 10:41:36 +00:00
rillig
18e278deae doc/guide: generate pkgsrc.pdf directly
The generated PDF file takes only 700 kB disk space instead of the
previous 1700 kB.
2020-06-21 04:45:36 +00:00
rillig
414c653313 doc/guide: adjust PLIST to removed Debugging chapter 2020-06-21 04:32:36 +00:00
rillig
1e4568d2d3 doc/guide: document the default do-* targets more precisely 2020-06-20 15:25:01 +00:00
rillig
f5a4a7e509 doc/guide: update from CVS before regenerating doc and htdocs 2020-06-20 14:55:06 +00:00
wiz
c3524ab876 Another try at improving the ABI/API section. 2020-06-20 09:47:05 +00:00
rillig
d91f7f3c2f doc/guide: merge debug chapter into creating
That chapter was not really about debugging pkgsrc but about creating a
package.
2020-06-20 05:31:10 +00:00
rillig
c25dd26a56 doc/guide: reorganize chapters
First give an introduction, then continue in chronological order, from
fetching over building to installing a package.
2020-06-20 04:52:26 +00:00
rillig
e9f184cbcd doc/guide: add usage statistics for the {pre,do,post}-* targets
Just to give a broad orientation about which of these targets are usual
and which are not.
2020-06-20 04:18:41 +00:00
wiz
bfb67ed7be Try to improve the BUILDLINK_A{B,P}I_DEPENDS description after
comments from rillig@.
2020-06-18 20:30:12 +00:00
leot
dfbfd6c988 guide: Document EARLY_PRINT_PLIST_AWK 2020-06-10 16:07:18 +00:00
rillig
35e5732e32 doc/guide: explain how to force compiler options in the build phase
https://mail-index.netbsd.org/tech-pkg/2020/06/07/msg023309.html
2020-06-07 23:11:16 +00:00
rillig
3d4dde697c doc/guide: add more details for set -eu in bulk build variant 2020-06-06 12:22:17 +00:00
rillig
f374c71565 mk, doc: remove obsolete bulk-install and bulk-package targets 2020-06-05 17:05:22 +00:00
rillig
4606a36212 doc/guide: proofread the SUBST section 2020-06-05 14:24:17 +00:00
rillig
99c18b02d9 doc/guide: rewrite the SUBST section, adding practical usage examples 2020-06-05 07:34:17 +00:00
rillig
d4851e97a5 doc/guide: there is no traditional non-pbulk bulk build anymore 2020-06-02 20:03:09 +00:00
rillig
0bb8dd9c17 doc/guide: reword paragraph about patches applying cleanly
The previous wording was too easy to get wrong.  Applying cleanly mainly
means that the context lines are as expected.  In most cases this is good
enough.  Having the exact line information would be nice as well, but if
this were crucial, pkgtools/pkgdiff would need to fix this sitation.
Since it doesn't and even states in a comment that it doesn't, the
situation can't be that bad.
2020-06-02 06:10:09 +00:00
rillig
6f118d787b doc/guide: hide bulk build variants that are not yet ready
https://mail-index.netbsd.org/tech-pkg/2020/05/30/msg023273.html
2020-05-30 19:25:17 +00:00
rillig
a80e654d82 doc/guide: fix typo in the bulk builds section 2020-05-30 08:22:59 +00:00
rillig
49bc36352a doc/guide: use the old http instead of the modern https for pkg_add
Even though pkg_add is distributed by NetBSD, it doesn't even trust the
server certificates from NetBSD itself.  It can only access http URLs.

Thanks, Sevan, for the heads-up.
2020-05-22 20:57:15 +00:00
rillig
8ea74df7fc doc/guide: document ideas for running bulk build variants 2020-05-22 18:50:08 +00:00
tnn
32e2e5830f g/c references to openjdk7 2020-05-17 00:54:00 +00:00
leot
3e225b9223 Fix the URL of pkg-vulnerabilities and consistently use https://ftp.n.o
URL like in using.xml.

Problem noticed by Jesus Cea on pkgsrc-users@, thanks!
2020-05-09 10:52:23 +00:00
gutteridge
ef57109ddb configuring.xml: the default Fortran is now gfortran 2020-05-06 01:41:12 +00:00
rillig
433df9baf1 doc/guide: remove documentation of WRAPPER_TRANSFORM_CMDS
It is not used anymore.
2020-05-03 08:27:10 +00:00
rillig
7203e6ff3a doc/guide: fix syntax for calling a shell function 2020-05-01 14:22:12 +00:00
gutteridge
0c35340834 introduction.xml: don't capitalize a clause that's merely a list 2020-04-29 23:54:10 +00:00
gutteridge
f843d1a65f fixes.xml: document TEST_DEPENDS 2020-04-29 23:48:44 +00:00
gutteridge
90e13ce821 creating.xml: document TEST_DEPENDS, and minor grammar fixes 2020-04-29 23:24:43 +00:00
gutteridge
6744b9403f bulk.xml: add a bulk build link, and tidy up grammar
Add a link to bulk build resource requirement estimates, and, while
here, fix some grammatical issues.
2020-04-29 23:20:42 +00:00
gutteridge
6313fb1e16 submit.xml: minor grammar tweaks 2020-04-29 23:09:48 +00:00
leot
8b8bad9f22 doc/guide: Update htdocs-share to 20200402 (pkgsrc-2020Q1) 2020-04-02 20:39:10 +00:00
rillig
dc870f2ad4 doc/guide: migrate from http to https 2020-02-24 21:13:56 +00:00
rillig
8788ce11dc doc/guide: document why autogenerated IDs are forbidden 2020-02-23 18:09:36 +00:00
rillig
7fca158c4a doc/guide: fix autogenerated HTML IDs 2020-02-23 17:43:20 +00:00
rillig
725653851a doc/guide: document more reasons for "No such file or directory"
https://mail-index.netbsd.org/pkgsrc-users/2020/02/23/msg030523.html
2020-02-23 17:27:29 +00:00