summaryrefslogtreecommitdiff
path: root/doc/guide
AgeCommit message (Collapse)AuthorFilesLines
2020-02-09doc/guide: don't suggest patch files against /dev/nullrillig1-8/+5
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-09doc/guide: explain how to track down where the CFLAGS are ignoredrillig1-1/+21
2020-01-28doc/guide: document SUBST_VARS, add gentle intro to SUBST frameworkrillig1-4/+24
2020-01-28doc/guide: make the pkglint output more realisticrillig1-4/+11
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-28doc/guide: do not advertise pkglint -Call anymorerillig1-2/+2
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-19doc/guide: fine-tune line breaks in source code and produced HTMLrillig1-33/+85
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-19doc/guide: reduce line length in chapter "Using pkgsrc"rillig1-2/+3
This avoids shrinking the text size in mobile devices since the zoom factor depends on the longest preformatted line.
2020-01-11doc/guide: document idiomatic use of the regress_fail functionrillig1-1/+2
2020-01-11doc/guide: document regress_fail for regression testsrillig1-1/+6
2020-01-11doc/guide: fix terminology of the regress directoryrillig1-4/+4
It's not a category since it doesn't contain packages to be installed.
2020-01-11doc/guide: fix spelling of Stack Overflowrillig1-2/+2
2020-01-06doc/guide: Update htdocs-share to 20200106 (pkgsrc-2019Q4)leot2-7/+7
2020-01-05doc/guide: add an example for SUPERSEDESrillig1-5/+11
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-04Add a rule to create EPUB fileryoon5-11/+21
* Sync htdocs with 20190104 * Do not build EPUB file by default
2020-01-03doc/guide: Bump copyright year to 2020leot1-3/+3
2019-12-06doc: Adjust case of NetBSD.orgleot1-2/+2
2019-12-06Update information to current reality (pkg-vulnerabilities is maintained byleot1-3/+3
pkgsrc Security Team and update pkg-vulnerabilities URL to the PGP signed one).
2019-11-22doc/guide: document the show-all target in the help sectionsrillig2-2/+30
2019-11-04doc/guide: fix type hinting in the placeholders utilityrillig1-4/+4
2019-11-04doc/guide: update for the type change of the variable BROKENrillig1-2/+2
2019-10-05doc/guide: Update htdocs-share to 20191005 (pkgsrc-2019Q3)leot2-7/+7
2019-08-30creating.xml: wrap line (no change to text)gutteridge1-2/+3
2019-08-25Add a description of 'make upload-distfiles' to the TeXlive package section.brook1-1/+14
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-18doc/guide: fix references to relative directoriesrillig1-3/+3
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-14Add a section to "Common packages" describing a typical TeXlive package.brook1-1/+37
2019-08-14Add a section to "Common packages" describing a typical R package.brook1-1/+20
2019-07-08doc/guide: Update htdocs-share to 20190708 (pkgsrc-2019Q2)leot2-7/+7
2019-05-20guide: Document TOOL_DEPENDSleot3-15/+45
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-05doc/guide: fill in the MASTER_SITE variables automaticallyrillig5-73/+94
Keeping these two lists in sync is not something that humans should do.
2019-05-03add help pagessevan1-1/+4
2019-05-03Drop the use of compression in CVS.sevan1-2/+2
"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-04-29doc/guide: use Python instead of Perl for autogenerating help topicsrillig3-53/+36
The code is shorter and there's less line noise.
2019-04-28doc/guide: add autogenerated chapter containing topics from "bmake help"rillig8-7/+97
2019-04-28doc/guide: add chapters for getting helprillig5-4/+77
2019-04-28doc/guide: remove outdated text from the Makefiles chapterrillig1-55/+25
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-19Fix a thinko.leot1-2/+2
Pointed out by Benjamin Lorenz via PR pkg/54128, thanks! (and thanks to <joerg>)
2019-04-09doc/guide: Update htdocs-share to 20190409 (pkgsrc-2019Q1)leot2-7/+7
2019-04-03typo found with xmllintsevan1-2/+2
2019-04-03Switch to using cdn.NetBSD.orgsevan1-7/+7
pkg-vulnerabilities file is fetched from ftp.NetBSD.org via http, see tnf_vulnerability_base in pkgtools/pkg_install/files/lib/parse-config.c
2019-04-03Switch http links for ftp.NetBSD.org to https links for cdn.NetBSD.orgsevan3-25/+25
2019-03-03guide: Improve formattingleot1-2/+2
Reported by J. Lewis Muir via PR pkg/54030.
2019-02-28guide: Improve/extend documentation about FTP layoutleot1-10/+31
- Document the `current', `stable' and `pkgsrc-20xxQy' more extensively, from J. Lewis Muir via PR pkg/54019. Thanks! - Refers to `pkgsrc.tar.{bz,gz,xz}' instead of just `pkgsrc.tar.gz' to cover all compressed formats. - Document `pkgsrc-readmes.tar.{bz,gz,xz}'
2019-02-26guide: Document stable directory (link to latest quarterly branch)leot1-1/+5
Requested by J. Lewis Muir via PR pkg/54015.
2019-01-02guide: adjust example for BUILD_DEPENDStnn1-2/+2
2019-01-01Welcome to 2019!jnemeth1-3/+3
2018-12-30doc/guide: Update htdocs-share to 20181231 (pkgsrc-2018Q4)leot2-7/+7
2018-11-05doc/guide: document the purpose of distinfo storing patch checksumsrillig1-2/+7
See https://mail-index.netbsd.org/tech-pkg/2018/11/04/msg020426.html.
2018-10-03doc/guide: Update htdocs-share to 20181003 (pkgsrc-2018Q3)leot2-7/+7
2018-09-18Update documentation to mention PKGSRC_KEEP_BIN_PKGS, and remove nowmaya1-10/+9
stale information of DEPENDS_TARGET. Heads up by Dean Matzkov in PR pkg/52708. (Now to the right place, not the generated output)
2018-09-10doc/guide: Reword CONFLICTS usage suggestionsleot1-26/+31
Despite most CONFLICTS are automatically detected at package installation time it is still a good idea to manually mark CONFLICTS in order to fail as early as possible instead e.g. of failing at package installation time after possibly installing several (maybe not needed) dependencies. Pointed out by discussion on pkgsrc-changes@ by <jperkin>: <https://mail-index.NetBSD.org/pkgsrc-changes/2018/09/09/msg180626.html> Last two paragraphs from <jperkin>, thanks! Also discussed with <wiz>, thanks!
generated by cgit v1.2.3 (git 2.39.1) at 2024-08-21 22:55:56 +0000