Commit graph

883 commits

Author SHA1 Message Date
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
rillig
55a58fb225 doc/guide: explain how to analyze and fix "No such file or directory"
https://mail-index.netbsd.org/pkgsrc-users/2020/02/23/msg030520.html
2020-02-23 16:52:02 +00:00
rillig
ec00da7229 doc/guide: remove accidental .exe from example package 2020-02-15 10:29:49 +00:00
rillig
63c639c020 doc/guide: fix markup in appendix
In appendix A, the word pkglint is meant as a utility name, not
necessarily the command. This change removes the bold formatting from the
toc, where it looked too unusual.
2020-02-15 10:28:06 +00:00
rillig
991a1842f2 doc/guide: don't suggest patch files against /dev/null
These patches would be much harder to edit and read than ordinary files.
Also recommend to copy these files in post-extract instead of
pre-configure, since extract is used for putting all files in place.
2020-02-09 19:06:12 +00:00
rillig
ebdd858b44 doc/guide: explain how to track down where the CFLAGS are ignored 2020-02-09 00:44:25 +00:00
rillig
2e14fa781e doc/guide: document SUBST_VARS, add gentle intro to SUBST framework 2020-01-28 05:07:58 +00:00
rillig
6ad5d8de65 doc/guide: make the pkglint output more realistic
The bison example package is quite old-fashioned, therefore the modern
pkglint generates quite a few warnings for it. These also serve better in
the example than a mere "looks fine".
2020-01-28 03:33:04 +00:00
rillig
8ad8c8b954 doc/guide: do not advertise pkglint -Call anymore
This option was kind of useful when the -Cextra option still existed (up
to 2019-02-19). After that date, it only enabled checks for the pkgsrc
infrastructure files, inter-package checks, as well as other checks on
files unrelated to the current package. These checks tend to be more
confusing than being helpful when checking a single package. They are
still useful when checking the whole pkgsrc tree at once, but that's a
special case.
2020-01-28 03:15:47 +00:00
rillig
0688b82cb6 doc/guide: fine-tune line breaks in source code and produced HTML
This keeps the font size on mobile devices more consistent by splitting
long preformatted lines.

Also, replace some http URLs with their https counterparts.
2020-01-19 14:12:27 +00:00
rillig
8cbfd875b5 doc/guide: reduce line length in chapter "Using pkgsrc"
This avoids shrinking the text size in mobile devices since the zoom
factor depends on the longest preformatted line.
2020-01-19 13:38:42 +00:00
rillig
0aefaa4b2f doc/guide: document idiomatic use of the regress_fail function 2020-01-11 11:50:51 +00:00
rillig
62cd3d5818 doc/guide: document regress_fail for regression tests 2020-01-11 11:48:59 +00:00
rillig
64a2d454a8 doc/guide: fix terminology of the regress directory
It's not a category since it doesn't contain packages to be installed.
2020-01-11 11:35:50 +00:00