Commit graph

99 commits

Author SHA1 Message Date
Ed Maste
3707c59faf committers-guide: update example to match guidance
We suggest capitalizing the first letter of the title line, so do so in
an example.

Reported by:	jhb
2021-02-25 18:57:12 -05:00
Fernando Apesteguía
9c65b2975b Update GPG key for fernape@
The old one was to expire in a few days.
2021-02-25 19:39:03 +01:00
Ed Maste
ef7b781366 committers-guide: update commit trailer descriptions
- 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
2021-02-24 14:02:53 -05:00
Dries Michiels
9ad75d64f7 [handbook] Remove reference to cusueeme
Following D26075, (remove cuseeme reference in ipfirewall), give the
handbook a similar treatment.

Approved by:	debdrup
Differential Revision:	https://reviews.freebsd.org/D26123
2021-02-24 13:56:41 -05:00
Mitchell Horne
337d010be1 Document __FreeBSD_version 1400005 2021-02-23 10:50:50 -04:00
Mark Johnston
e84bd3dbae Document __FreeBSD_version 1400004 2021-02-23 10:50:32 -04:00
Li-Wen Hsu
777b5f63e7
Adjust the year again to keep time machine in secret
Approved by:	carlavilla (implicitly)
2021-02-23 20:14:43 +08:00
Li-Wen Hsu
4e8f7e108e
Change the year to hide the existence of time machine
Approved by:	carlavilla (implicitly)
2021-02-23 17:37:50 +08:00
Ceri Davies
1bc7558ecb handbook/l10n: Correct reference to csh login file
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
2021-02-22 20:51:25 +01:00
Ceri Davies
a0f7ad455b Multiple files: Fix 'shared' references
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
2021-02-22 19:29:41 +01:00
Ed Maste
b2a9be92ae committers-guide: add missing line break in commit message section
Fixes: 11f8235774 ("Add commit message information to committer's guide")
2021-02-20 14:09:20 -05:00
Ed Maste
11f8235774 Add commit message information to committer's guide
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
2021-02-20 13:44:21 -05:00
Joseph Mingrone
b7744f2b75
Porter's Handbook: Document DISABLE_CONFLICTS variable
Requested by:	linimon
Reviewed by:    crees
Approved by:    doc (ygy)
Differential Revision:  https://reviews.freebsd.org/D28582
2021-02-19 11:46:09 -04:00
Joseph Mingrone
47dc6685eb
Porter's Handbook: Tweak conflict instructions
Reviewed by:	crees
Approved by:	doc (ygy)
Differential Revision:	https://reviews.freebsd.org/D28582
2021-02-19 11:45:54 -04:00
Marc Fonvieille
cb2679f843 Typ: s/upto-date/up-to-date 2021-02-18 18:44:54 +01:00
Andreas Bjørnestad
2d46e9e3f1 handbook/l10n: Fix malformed note
It seems this mixtake happened by accident during the AsciiDoctor
conversion, as it's not present in the last svn revision locally.

PR:		253581
2021-02-17 17:04:01 +01:00
Andreas Bjørnestad
9fdfd323ed serial/ppp-slip: Fix typos and improve wording
PR:		253578
2021-02-17 09:38:17 +01:00
Rajesh Kumar M A
1c5c36df2d Documentation repo changes to add new committer Rajesh Kumar M A
Approved by: vmaffione, gallatin

Differential Revision: https://reviews.freebsd.org/D28587
2021-02-17 06:24:38 +00:00
Sergio Carlavilla Delgado
e7ea1aea59 Incorrect $FreeBSD$ expansion in Building Products articles
PR:         253554
Patch by:   ceri (AT) submonkey.net
2021-02-16 22:48:12 +01:00
Sergio Carlavilla Delgado
bba35091cd Correct path in DOS handbook example.
PR:         253560
Patch by:   ceri (AT) submonkey.net
2021-02-16 22:26:10 +01:00
Sergio Carlavilla Delgado
554d53992e Remove RCS recommendation in the translations section of FDP
PR:         253556
Patch by:   ceri (AT) submonkey.net
2021-02-16 22:24:21 +01:00
Yasuhiro Kimura
8750cad450 Makefiles and FDP: Change python binary
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.
2021-02-16 19:29:11 +01:00
Andreas Bjørnestad
c724ce033b handbook: Fix typo 2021-02-15 09:51:01 +01:00
Daniel Ebdrup Jensen
989bbd57fa Makefiles: Add a conditional check on HOSTNAME variable
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.
2021-02-14 22:50:52 +01:00
Sergio Carlavilla Delgado
263ce26710 Sync bsdinstall chapter of the handbook in Japanese 2021-02-14 16:35:21 +01:00
Sergio Carlavilla Delgado
68d382e835 Sync japanase biblio handbook chapter 2021-02-14 13:00:57 +01:00
Sergio Carlavilla Delgado
8dc71efa19 Restore the generation of the TOCs in the Makefile
Restore the generation of the TOCs in the Makefile
when running make run
2021-02-13 22:40:00 +01:00
Sergio Carlavilla Delgado
fb36cfdfb2 Add gitref macro to reference a git hash
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@
2021-02-13 22:22:34 +01:00
Daniel Ebdrup Jensen
4023bd3f77 FDP: Fix typo
Reported by:	ceri
2021-02-13 19:43:27 +01:00
Ryusuke SUZUKI
35f8a9cdb5 Update my PGP key 2021-02-14 00:43:36 +09:00
Daniel Ebdrup Jensen
b046222873 FDP: Remove extraneous article
Pointy hat to:	me
Reported by:	PauAmma
2021-02-13 07:14:24 +01:00
Yasuhiro Kimura
b474a50019 FDP: Refer to the proper package name for hugo
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
2021-02-12 22:57:29 +01:00
Daniel Ebdrup Jensen
04b118c626 FDP: Correct some grammar and mistakes
Correct some grammar, some factual information and a misrepresentation
of that the "word list" is.

Submitted by:	ceri
PR:		253467
2021-02-12 20:52:02 +01:00
Ceri Davies
7ed46663b3 FAQ: Fix a typo
- witout -> without

PR:	253456
Reported by:	Ceri Davies <ceri at submonkey dot net>
2021-02-12 18:44:14 +01:00
Ceri Davies
b687b57a9c Handbook: Fix some typos
- "ApacheHTTPD" -> "Apache HTTPD"
- theDNS -> "the DNS"
- example in rc.conf: lapd_enable -> slapd_enable

PR:     253458
Reported by:    Ceri Davies <ceri at submonkey dot net>
2021-02-12 18:37:26 +01:00
Adriaan de Groot
edf6cdf3c5 Update GPG key for adridg@ -- Li-Wen pointed out I was using old tools for this 2021-02-11 21:00:03 +01:00
Adriaan de Groot
2302fc638f Update GPG key for adridg@ -- extend expiry by 2 years less 13 days 2021-02-11 15:40:02 +01:00
Warner Losh
ea2dde38df Update shared library advice now that a.out no longer is a consideration
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
2021-02-08 17:04:05 -07:00
Sergio Carlavilla Delgado
dff8699750 Remove HAL from the X11 chapter.
HAL has been remove with r564691

PR:             253345
Submitted by:   0mp@
2021-02-08 23:33:23 +01:00
Sergio Carlavilla Delgado
d8ac41d0c8 Remove the font size of filename class
PR:         253353
Patch by:   ceri (at) submonkey.net
2021-02-08 23:25:18 +01:00
Sergio Carlavilla Delgado
feb1f7a97c Remove unused partial, correct year copyright and remove space
The sidenav partial it's not used in the documentation project.
Update copyright in header
Remove space in site-navigation partial
2021-02-08 23:09:19 +01:00
Sergio Carlavilla Delgado
ad3bb85dd0 Fix copyright and contact links in the footer.
PR:             253094
Submitted by:   wosch@
2021-02-08 22:47:38 +01:00
Ceri Davies
95da5a5d64 Correct the grammar in a sentence about beastie.png
PR:		253352
2021-02-08 19:41:15 +01:00
Ceri Davies
4bf990d288 Ensure that /usr/local/etc/pkg/repos exists
The directory /usr/local/etc/pkg/repos doesn't exist by default, so have
it created in an example that will  otherwise fail.

PR:		253351
2021-02-08 19:32:23 +01:00
Alessandro Sagratini
aef3238f41
Typo fix: s/neseccary/necessary/
PR:		252973
Reported by:	Alessandro Sagratini <ale_sagra@hotmail.com>
Approved by:	ygy (doc)
2021-02-08 23:14:57 +08:00
Fernando Apesteguía
5d0182eabb [handbook]: Document how to mount NTFS disks
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
2021-02-07 19:31:53 +01:00
Nuno Eduardo Simões Leal Teixeira
17eef34c77 Steps 1-4 from the Committer's guide (eduardo) 2021-02-07 14:18:04 +00:00
Li-Wen Hsu
ace7a25543
Fix navigation links on i18n pages
PR:		253134
Reported by:	wosch
Approved by:	carlavilla (implicitly)
2021-02-07 14:37:25 +08:00
Li-Wen Hsu
efb1bb8d4c
Sync with www.freebsd.org
Approved by:	carlavilla (implicitly)
2021-02-07 13:38:24 +08:00
Li-Wen Hsu
913df4a581
Add missing Git Repository label translation
Approved by:	carlavilla (implicitly)
2021-02-07 13:35:56 +08:00