Commit graph

856 commits

Author SHA1 Message Date
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
rillig
a6e6b1068b doc/guide: fix spelling of Stack Overflow 2020-01-11 11:34:37 +00:00
leot
23f0d13454 doc/guide: Update htdocs-share to 20200106 (pkgsrc-2019Q4) 2020-01-06 21:34:31 +00:00
rillig
b73624f438 doc/guide: add an example for SUPERSEDES
This example makes it easier to see that the assignment operator should
always be += instead of a simple =. Also remove the word dewey since that
is a classification scheme for libraries, not a versioning scheme.
2020-01-05 21:35:33 +00:00
ryoon
fa7800e5a8 Add a rule to create EPUB file
* Sync htdocs with 20190104
* Do not build EPUB file by default
2020-01-04 12:14:22 +00:00
leot
3d1c65e598 doc/guide: Bump copyright year to 2020 2020-01-03 15:55:24 +00:00
leot
a3c1496ac3 doc: Adjust case of NetBSD.org 2019-12-06 14:30:12 +00:00
leot
78e2f5f9c4 Update information to current reality (pkg-vulnerabilities is maintained by
pkgsrc Security Team and update pkg-vulnerabilities URL to the PGP signed one).
2019-12-06 14:20:44 +00:00
rillig
1f68ce5c66 doc/guide: document the show-all target in the help sections 2019-11-22 19:48:58 +00:00
rillig
022f667b87 doc/guide: fix type hinting in the placeholders utility 2019-11-04 18:58:30 +00:00
rillig
fa7710e9fe doc/guide: update for the type change of the variable BROKEN 2019-11-04 18:47:27 +00:00
leot
31f00e6adb doc/guide: Update htdocs-share to 20191005 (pkgsrc-2019Q3) 2019-10-05 08:50:35 +00:00
gutteridge
75c5acc051 creating.xml: wrap line (no change to text) 2019-08-30 22:19:37 +00:00
brook
3fa3e0e49e Add a description of 'make upload-distfiles' to the TeXlive package section.
TeXlive packages are unusual in avoiding direct downloads from the upstream
CTAN repository.  Therefore, developers must manually upload the appropriate
distfiles.  To help avoid forgetting this step, add a description to the
Pkgsrc Guide in the section describing TeXlive packages.
2019-08-25 17:11:00 +00:00
rillig
741a7fa7ed doc/guide: fix references to relative directories
For more than 15 years, pkglint complains about relative directories that
take shortcuts. All relative paths between packages should first go up to
the pkgsrc root and from there to the package.
2019-08-18 16:35:16 +00:00
brook
1895614126 Add a section to "Common packages" describing a typical TeXlive package. 2019-08-14 17:31:34 +00:00
brook
be9b66ada7 Add a section to "Common packages" describing a typical R package. 2019-08-14 17:26:31 +00:00
leot
01be806d20 doc/guide: Update htdocs-share to 20190708 (pkgsrc-2019Q2) 2019-07-08 10:11:38 +00:00
leot
40cad5e0ac guide: Document TOOL_DEPENDS
Document TOOL_DEPENDS and clarify the differencies with BUILD_DEPENDS.
Adjust previous BUILD_DEPENDS examples (all of them were actually
TOOL_DEPENDS).

XXX: No BUILD_DEPENDS example is provided, if you have any good and common
XXX: BUILD_DEPENDS example please add it (a TODO comment was added regarding
XXX: that).  At least according a quick grep of BUILD_DEPENDS probably most of
XXX: them are actually BUILD_DEPENDS and maybe all real BUILD_DEPENDS are via
XXX: buildlink3.mk inclusion.
2019-05-20 18:14:24 +00:00
rillig
629d9c85db doc/guide: fill in the MASTER_SITE variables automatically
Keeping these two lists in sync is not something that humans should do.
2019-05-05 18:36:05 +00:00
sevan
1c6d0a6f6c add help pages 2019-05-03 10:53:31 +00:00
sevan
efd723eb91 Drop the use of compression in CVS.
"Do not use the cvs `-z` flag. The data stream gets out of sync,
leading to corruption on the client, or causing the client to hang
completely."
2019-05-03 10:35:37 +00:00
rillig
1e66e9f495 doc/guide: use Python instead of Perl for autogenerating help topics
The code is shorter and there's less line noise.
2019-04-29 16:18:41 +00:00
rillig
6e80859641 doc/guide: add autogenerated chapter containing topics from "bmake help" 2019-04-28 15:22:24 +00:00
rillig
c912c9236b doc/guide: add chapters for getting help 2019-04-28 13:41:18 +00:00
rillig
fa2fd523f7 doc/guide: remove outdated text from the Makefiles chapter
Most of the wording was based on the pkglint implementation from before
2015 and was too technical to be useful. Since 2015, bmake doesn't split
the .for arguments on simple whitespace but uses brk_string as well,
therefore that information was outdated.
2019-04-28 11:16:07 +00:00
leot
f5ba0978c2 Fix a thinko.
Pointed out by Benjamin Lorenz via PR pkg/54128, thanks! (and thanks
to <joerg>)
2019-04-19 13:43:27 +00:00
leot
42d085b5a2 doc/guide: Update htdocs-share to 20190409 (pkgsrc-2019Q1) 2019-04-09 13:43:53 +00:00