Commit graph

158 commits

Author SHA1 Message Date
Sergio Carlavilla Delgado
3c2a5e96f9 Improve wording in ZFS chapter
PR:         253075
Patch by:   panden(at)gmail.com
2021-03-03 21:55:40 +01:00
Sergio Carlavilla Delgado
8ee5df0179 Add two manual pages in bsdinstall section
PR:             253875
Submitted by:   bruce.lilly (AT) gmail.com
2021-03-03 21:16:34 +01:00
Sergio Carlavilla Delgado
4f24ed91c2 Add example to generate pdf document in FDP
PR:             253178
Submitted by:   kib@
2021-03-03 21:13:08 +01:00
Alexis Praga
b0fd969121 handbook/linuxemu: show how to mount linprocfs
Some programs expect procfs and other Linuxisms.

PR:		docs/195209
Reported by:	ngie
2021-03-03 16:53:42 +00:00
Chris Rees
be6f122288 Remove dated and misleading paragraph on headers
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
2021-03-03 15:13:22 +00:00
Chris Rees
62371d2fa9 Update summary Bugzilla standard format for ports
PR:		docs/232816
Submitted by:	salvadore
Reviewed by:	ygy
Differential:	https://reviews.freebsd.org/D23590
2021-03-03 14:59:20 +00:00
Marc Fonvieille
da3c5d0fea Fix some typos. 2021-02-28 19:55:15 +01:00
Sergio Carlavilla Delgado
d37975ff27 Finish the sync of japanase handbook
Chapters: X11, multimedia, security, l10n and cutting-edge.

With this last sync, all the handbook is finished.
2021-02-28 11:48:21 +01:00
Marc Fonvieille
096183a715 s/WindowMaker/Window Maker 2021-02-27 19:00:00 +01:00
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
Li-Wen Hsu
ebd47aa134
Use production setting
PR:		253134
Reported by:	wosch
Approved by:	carlavilla (implicitly)
2021-02-07 13:05:13 +08:00
Li-Wen Hsu
16168ab123
Remove EOL'd FreeBSD 12.1 from "Production Release" in side navigator
In both documentation and website, also fix wrong link.

Approved by:	carlavilla (implicitly)
2021-02-06 13:10:23 +08:00
Li-Wen Hsu
48eff74004
Remove EOL'd FreeBSD 12.1 from "Production Release" in side navigator
Approved by:	carlavilla (implicitly)
2021-02-06 12:27:23 +08:00
Daniel Ebdrup Jensen
4ace6ff83e handbook/virtualization: Suggest using supported RELEASE for bhyve
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).
2021-02-06 02:55:08 +01:00
Glen Barber
16e7cfb746 fix __FreeBSD_version after 3c6a89748a01
Sponsored by:	Rubicon Communications, LLC ("Netgate")
2021-02-05 11:41:57 -05:00
Glen Barber
118a5fec79 fix __FreeBSD_version 1305000 entry.
Pointyhat:	gjb (myself)
Sponsored by:	Rubicon Communications, LLC ("Netgate")
2021-02-04 19:12:06 -05:00
Glen Barber
b776d2274b Document __FreeBSD_version 1305000
Approved by:	re (implicit)
Sponsored by:	Rubicon Communications, LLC ("Netgate")
2021-02-04 19:06:26 -05:00
Warner Losh
e2223b82bd Minor wordsmithing to reflect current practice
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.
2021-02-04 11:43:50 -07:00
Warner Losh
612d995019 More markup fixes
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
2021-02-04 11:21:34 -07:00
Warner Losh
4830802786 Fix minor markup issues with updating vendor import section 2021-02-04 10:49:28 -07:00
Warner Losh
b3f6ba6ff5 Start to update the committer's guide with git information
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.
2021-02-04 10:36:16 -07:00
Warner Losh
e73763e350 Convert vendor imports to git instructions
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
2021-02-04 10:36:08 -07:00
Ed Maste
fbc1409c73 Use @generated in generated files
@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
2021-02-04 09:39:06 -05:00
Warner Losh
e11aaf5a76 Revert "Convert vendor imports to git instructions"
This reverts commit 4fc73e884c.

4fc73e884c was pushed w/o review by mistake.
2021-02-03 17:43:45 -07:00
Warner Losh
4fc73e884c Convert vendor imports to git instructions 2021-02-03 17:40:30 -07:00
Warner Losh
32f3af824f Remove old, draft version of git primer.
This contains a very early version of the git primer that's incomplete. It's
also unreferenced in the tree. Remove it.
2021-02-03 15:15:08 -07:00
Brandon Bergren
bd3ec6a734 Trivial change: Remove duplicated paragraph. 2021-02-02 10:19:12 -06:00
Bjoern A. Zeeb
32e2174cf3 Document my bump for 1300139 and try to document mjg's missing one.
Sponsored-by:	The FreeBSD Foundation
2021-02-02 12:16:53 +00:00
Allan Jude
9374bec486 bsdinstall: Fix corrupted table
Sponsored By:	Klara Inc.
2021-02-02 00:59:21 -05:00
Sergio Carlavilla Delgado
f777b95139 Convert Vincenzo pgpkey to AsciiDoc 2021-02-01 22:33:12 +01:00
Sergio Carlavilla Delgado
57930f3fd5 Upgrade pgpkeys related tools and committers guide new committer section 2021-02-01 22:23:03 +01:00
Glen Barber
790a769f67 releng: fix rendering of replaceable variables
Add 'subs="attributes"' to [source] and [.programlisting] blocks
to properly replace variables in rendered output.

Sponsored by:	Rubicon Communications, LLC ("Netgate")
2021-02-01 16:15:09 -05:00
Gordon Bergling
fabd1efd2c Handbook: ZFS chapter: Correct a grammar mistake (with -> will)
PR:	253153
Submitted by:	Andreas Bjørnestad <panden at gmail dot com>
2021-02-01 19:20:33 +01:00
Vincenzo Maffione
bdb56d32ce Update my PGP key (using addkey.sh) 2021-02-01 07:50:02 +00:00
Allan Jude
a4b2772516 Fix broken link to the BSD family tree in the FAQ 2021-01-31 20:19:23 -05:00
Allan Jude
bc185da8de Improve the documentation front page with full book/article names
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
2021-01-31 20:09:37 -05:00
Sergio Carlavilla Delgado
d8d889ea90 MFH info missing from Committers Guide
Restore MFH info in the committers guide.

PR:             253065
Submitted by:   fernanpe@
2021-01-30 20:36:26 +01:00
Sergio Carlavilla Delgado
1ff4da59ba Finalize document synchronization in pt-br
Finalize document synchronization in pt-br by migration to AsciiDoc
2021-01-30 18:58:43 +01:00
Dimitry Andric
e9f8cbb45f Document __FreeBSD_version value 1300137. 2021-01-30 00:51:14 +01:00
Sergio Carlavilla Delgado
67b8d471d4 Remove unnecessary step in FDP quick start guide
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
2021-01-29 18:23:26 +01:00
Sergio Carlavilla Delgado
85faabdc47 Update build chapter in FDP
Update the build chapter in the FDP to reflect the new
build system.

Patch by:               kevans@
Differential Revision:  https://reviews.freebsd.org/D28409
2021-01-29 18:20:04 +01:00
Kyle Evans
127d3f2965 build: remove generate target, split run out
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
2021-01-28 21:15:10 -06:00
Kyle Evans
885316d9e8 build: slap fake targets with .PHONY
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
2021-01-28 21:15:10 -06:00
Kyle Evans
dc7b79a328 build: slap some .ORDER on targets
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
2021-01-28 21:15:10 -06:00
Kyle Evans
98844c28f4 build: replace move-shared/copy-shared with a symlink
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
2021-01-28 21:15:10 -06:00
Bjoern A. Zeeb
df4fdb99eb Document __FreeBSD_version 1400003
(LinuxKPI changes conflicintg with drm-kmod).

Sponsored-by:	The FreeBSD Foundation
2021-01-28 17:25:14 +00:00
Sergio Carlavilla Delgado
a62f2c7bd3 Fix a few nits in the Rosetta stone section of the FDP primer.
Patch by:               pauamma_gundo.com
Differential Revision:  https://reviews.freebsd.org/D28360
2021-01-27 21:01:04 +01:00
Sergio Carlavilla Delgado
ab8cd36cda Improve the column widths of various pages in the FDP
Patch by:               allanjude@
Differential Revision:  https://reviews.freebsd.org/D28358
2021-01-26 20:45:47 +01:00
Dimitry Andric
563997d288 Abbreviate displayed git hashes to 12 hex digits. 2021-01-26 20:25:57 +01:00
Dimitry Andric
078e5ea093 Fix links to onetbb and libiconv ports. 2021-01-26 20:25:57 +01:00
Sergio Carlavilla Delgado
7808bd27ab Enable robots.txt in docs.freebsd.org
Enable again robots.txt for docs.freebsd.org

PR:             253031
Submitted by:   wosch@
2021-01-26 20:17:05 +01:00