We no longer have any of the "Ports collection Makefile for...." lines,
so they do not need to be explained.
Differential: https://reviews.freebsd.org/D23589
Submitted by: salvadore (based on)
Reviewed by: mat
- Add `Reported by`, `Tested by`, `Fixes`, `MFH`.
- Mention that `Submitted by` is typically not used with git.
- Add more cases to `Approved by`.
- Move `Sponsored by:` to the same place it appears in the template.
Reviewed by: debdrup
Approved by: debdrup
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D28905
Following D26075, (remove cuseeme reference in ipfirewall), give the
handbook a similar treatment.
Approved by: debdrup
Differential Revision: https://reviews.freebsd.org/D26123
The l10n chapter directs people to add things to ~/.csh.login but
testing reveals that ~/.login is the right path.
This has also been corroborated by dtrace, and the csh(1) manual page
also refers to ~/.login.
PR: 253758
The hier(7) man-page lists /usr/share as the location for
architecture-independent files, so fix a few instances where the
documentation referes to /usr/shared instead of /usr/share.
PR: 253760
Provide some guidance on good git commit messages. Based on an article
I wrote, with further editing and feedback by imp in the temporary git
docs repo.
Reviewed by: debdrup, imp
Approved by: debdrup
Differential Revision: https://reviews.freebsd.org/D28815
Currently '/usr/local/bin/python3.7' is used as the value of
PYTHON_CMD. Right now this works because 3.7 is the default version of
Python 3 in the ports tree. However, at some point in the future, this
will be undoubtedly be changed.
It is also possible that users already might be building versions
newer than the default port/package, which needs to be an supported as
well.
In addition, the FDP recommends installing the 'python3' package. This
meta port/package depends on the default version of python, and
automatically creates a symlink to the default version.
With all this in mind, use '/usr/local/bin/python3' is used as the value
of PYTHON_CMD, since this means that the instructions will work
irrespective of which version is assigned.
In order for hugo to build all links correctly, it is necessary to
define baseURL - but in order to do this, we need some way of adding a
hostname. This change adds the HOSTNAME variable to accomplish this.
Another advantage is that if HOSTNAME is set to something other than
localhost, hugo can be run on a different (more powerful) machine which
can shorten the time it takes to build.
A note about this will need to be added to the FDP later.
With this extension a git hash can be easily referenced.
The porters handbook versions chapter uses this extension
as an example in the FreeBSD 14.0 version table.
An example of use
gitref:hash[repository="src|doc|ports",length=hash-longitude]
The repository should be src, doc or ports.
And if no length it's specified the macro will use 12 characters
of the specified hash.
PR: 253050
Submitted by: jhb@
The package name 'hugo' refers to emulators/hugo, a PC Engine
(TurboGrafx 16) emulator, whereas the hugo that is required by the new
framework is www/gohugo. A similar case applies with the package name of
AsciiDoctor, which is 'rubygem-asciidoctor'.
Therefore fix package names so they refer to proper ones.
PR: 253470
Remove old a.out information. Update the policy to match our current practice of
rarely, if ever, bumping the major version of libraries, but instead relying on
symbol versioning to maintain a stable ABI. Move from paragraph form to bullet
points. Also, tweak the 'once per major release' policy to 'as needed' because
the conditions that existed for the former no longer apply.
Discussed with: jhb@
Reviewed by: kib@, debdrub@
Differential Revision: https://reviews.freebsd.org/D28486
How to mount NTFS disks is a FAQ in our chats and forums.
Add a section in handbook/disks under "18. Storage" with
straightforward information on how to mount NTFS disks.
PR: 251109
Submitted by:
Reported by: 0mp@
Reviewed by:
Approved by: 0mp@ (mentor)
Obtained from:
MFC after:
MFH:
Relnotes:
Security:
Sponsored by:
Differential Revision: https://reviews.freebsd.org/D28131
Since 10.3-RELEASE has gone EOL a while ago, update instructions to
match the newest -RELEASE on the newest releng branch as of writing.
While here, also correct at typo that instructed people to look in
/usr/shared which doesn't exist in hier(7).
Generally things are done by consensus, with the core team stepping in when
there's a dispute. Update the documented encumbered software policy to reflect
what's actually done and is considered to be working. This harmonizes the wording
for contributed software and encumbered software. Also wordsmith how Release
Engineering is referenced. Also removes stray > marks on object files. Also
document the fw files.
Note: the ascii file requierment dates from CVS days and should change. But
I've not pushed things that far in this commit.
Get the sections rendering correctly in hugo
Convert markdown enumerated list convention to asciidoc
Remove stray '+' lines
Small tweak in wording missed in review for this content's new context
Do the easy git updates for URLs and branch names. Note svn guide
is just for ports (but don't edit out the src specific bits
since we'll dump it wholesale in 2 months). Add pointer to my
draft docs until they can all be integrated.
Now that subversion is gone, replace the subversion info with git info.
Note: This was pulled in from my github repo. Fixes contributed
by jrm@, uqs@, woodsb02@, delphij@, rpokala@ and ceri@
Reviewed by: emaste@ (earlier version, conditional), gjb@
Differential Revision: https://reviews.freebsd.org/D28474
@generated is used by various tools to identify generated files.
For example, Phabricator will not display diffs in generated files
by default.
Reviewed by: gjb
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D28446
Add 'subs="attributes"' to [source] and [.programlisting] blocks
to properly replace variables in rendered output.
Sponsored by: Rubicon Communications, LLC ("Netgate")
Use the title of the book or article rather than the directory name
Also use the full name of the language, not just the short code
Sponsored by: Klara Inc.
Reviewed by: carlavilla
Differential Revision: https://reviews.freebsd.org/D28440
Remove unnecessary step when the user install
the required tools for the website and documentation.
There's no need to move the shared folder between projects
This ensures that `make all` will never try to run the internal server.
Instead, the user can run it manually if they need to.
Reviewed-by: gjb, hrs
Differential-Revision: https://reviews.freebsd.org/D28384
This instructs make(1) to consider them always out of date, and prevents
foot-shooting if a directory entry with the same name comes into existence.
Reviewed-by: gjb, hrs
Differential-Revision: https://reviews.freebsd.org/D28383
This ensures that the build still generally works if one specifies jobs and
multiple targets at the same time.
Reviewed-by: gjb, hrs
Differential-Revision: https://reviews.freebsd.org/D28382
The build should strive to not write to the shared space, so symlink these
back to the one copy and remove the prep work needed.
Reviewed-by: gjb, hrs
Differential-Revision: https://reviews.freebsd.org/D28381