Commit graph

154 commits

Author SHA1 Message Date
Sergio Carlavilla Delgado
762d41ceb7 Fix manual pages macros in rc-scripting and linux-users 2021-03-20 08:41:39 +01:00
Warner Losh
05792e1b62 Minor word smithing
Fix a few typoes, grammar errors, wrong word choices, and a bad url.

Submitted by: Pau Amma
2021-03-19 14:19:28 -06:00
Sergio Carlavilla Delgado
1cdbcb161b Fix typos, style and fix AsciiDoc syntax in bsdl-gpl, building products and committers guide
bsdl-gpl: style line
building products: style line and fix images path
committers-guide: style line, convert some MarkDown
links to Asciidoc and upgrade some entries still making
reference to the old Docbook tech.
2021-03-19 15:01:14 +01:00
Warner Losh
df7847b887 spdx: document usage
Document that we try to follow SPDX 2.2 for the SPDX-License-Idneitfier: tags
that are in the source. Note that they are informative only. Give pointers to
the standards and a status of the files marked in-tree.

Suggestions by: Pau Amma
Differential Revision:	https://reviews.freebsd.org/D29330
2021-03-18 20:08:53 -06:00
Warner Losh
9fc1c18c75 Lots of improvements.
Lots of wording improvements, grammar errors, punctuation error and wrong word
fixes.  Also, do some limited one sentence one line (1s1l) conversion.

Submitted by: Pau Amma (though not the 1s1l stuff).
2021-03-18 20:08:17 -06:00
Warner Losh
78a21ab121 Misc tweaks for arm64 and sparc64
Add arm and arm64 minimal requirements
Remove sparc64 reqiurements and VTOC since that's been removed.
2021-03-18 16:22:22 -06:00
Warner Losh
3bbe81a675 git: add FAQ
Add in the FAQ from the github docs I did for the transition.

Submissions from: rpokala@, jrm@, Marc Branchaud and "mirror176".
2021-03-18 15:55:16 -06:00
Warner Losh
28d4e1377a MFC: tweak the langauge
Don't say there are two options and then give only one. Update that
sentence to reflect where the project seems to have landed in terms of
how to do MFCs.  The original was written prior to the transtion and the
existing practice has shifted to cherry-pick -x almost exclusively.
2021-03-18 14:45:46 -06:00
Warner Losh
0181ba1611 MFC: update advice on MFC practices
Highlight MFC to a branch needing approval
Rearrange a couple sections to improve document structure.
Change some enumeration lists to bulleted lists since I think that looks nicer.
2021-03-18 14:30:53 -06:00
Ka Ho Ng
b4977a4f42 Document __FreeBSD_version 1400006
Sponsored by:	The FreeBSD Foundation
Approved by:	philip (mentor)
Differential Revision:	https://reviews.freebsd.org/D29312
2021-03-18 09:32:58 +08:00
Warner Losh
f18f371e01 Another round of typos
Submitted by: Pau Amma
2021-03-17 18:30:17 -06:00
Warner Losh
a7ec32b97b Wording improvements
Describe how to collapse multiple MFCs better. Use consistent punctuation. fix
some typos.

Submitted by: Pau Amma
2021-03-17 17:35:37 -06:00
Warner Losh
43ae2e8007 Improve text in several ways
Fix typos, improve wording, remove redundantly repetitive words, fix punctuation
and grammer errors.

Submitted by: Pau Amma
2021-03-17 17:29:17 -06:00
Warner Losh
d5ea2ebac2 committer handbook: Fix typos and reformat
Fix a few typos and reformat a few paragraphs to one line per sentence
style.  Try to use repository insteast of 'repo' or even 'source of
truth'. Clarify a few places and fix some grammar errors.

Submitted by: Pau Amma
2021-03-17 16:53:22 -06:00
Benjamin Kaduk
1f654f7b88 Fix typo in committers guide 2021-03-17 10:50:44 -07:00
Warner Losh
c78343dcce xxx: remove xxx
Remove a couple of links that I didn't go back and fix before committing.
2021-03-17 11:41:51 -06:00
Warner Losh
ad41defcd5 Update vendor import with suggestions
Add git commit --amend with a comment about doing a final check of the commit
message before the push. Update with some more specific guidance on a good
commit message. Add link to commit message section. Minor tweaks I noticed
while doing this as well for having one setence one line.

Submitted by cy@
2021-03-17 11:23:46 -06:00
Warner Losh
8401b7bbb6 Add the git miniprimer
Add in the git minirpimer from my github. It contains the basics that
you'll need to track the tree and/or contribute.

Contributions by: rwatson@, Rainer Hurling, jhb@, Ceri Davies, lwhsu@,
	chuck@, Robert Gogolok
2021-03-17 11:23:46 -06:00
Chris Rees
ecc2b1a6a0 Remove instructions on boot splash screens
They haven't worked for years in the way described, and following
further advice online to enable VESA results in an unbootable system!

It can be put back when vt(4) supports them.

PR:		kern/210432
2021-03-17 17:00:03 +00:00
Li-Wen Hsu
2191c44469
Committer's Guide: list the new commits mailing lists to replace svn ones
Approved by:	carlavilla (implicitly)
2021-03-18 00:36:57 +08:00
Warner Losh
d24ea0f845 Document what Signed-off-by means
We get submissions with this from time to time, so document what signed-off-by
means. It's not used extensively in FreeBSD at this time.
2021-03-17 00:25:24 -06:00
Warner Losh
abff932fe8 Merge in the migration from subversion / github
Add in the migrating from the old subversion / git docs. This section
should be removed in a few months maybe.

Contributions by: lwshu@, Alexander Richardson, kib@, Ceri Davies
2021-03-16 22:23:19 -06:00
Ka Ho Ng
aa0d0c1422 Alternative formatting on freebsd/developer/* blocks
Use angle brackets instead of italic to denote mandatory fields after
"freebsd/developer/" blocks. "freefall name" and "NickServ name" are
also renamed to "freefall username"` and "FreeNode account".

Reviewed by:	debdrup, ygy, lwhsu
Approved by:	philip (mentor)
Differential Revision:	https://reviews.freebsd.org/D29285
2021-03-17 10:47:04 +08:00
Warner Losh
965da1835e Move the MFC doc from my freebsd-git-docs repo to handbook
Integreate MFC procedures into the committer's handbook. This was originally in
my freebsd-git-docs repo where it was collaberatively created. The changes here
are light edits and a conversion from markdown to asciidoc.

Contributions from: jhb@, lwhsu@, delphij@, Ceri Davies, Alexandre
2021-03-16 20:09:36 -06:00
Warner Losh
3a52e436d3 Two more typos I made while fixing the last typos.
Noticed by: Pau Amma
2021-03-16 19:03:56 -06:00
Warner Losh
86836673be Fix more typos from the original github docs
Fix a number of typos. Note why one would prefer publishing a repo over
phabricator. Try to minimize use of contractions. Clarify the mysterious 'source
of truth' phrase.

Noticed by: Pau Amma (except the contractions)
2021-03-16 18:43:35 -06:00
Warner Losh
a7f71f22a4 Doh! The double #git-primer slipped in w/o my noticing it. Remove second one 2021-03-16 18:08:01 -06:00
Warner Losh
b4b797a0ce Fix link to committer's guide 2021-03-16 17:44:48 -06:00
Warner Losh
371c80a880 git: Move vendor branch stuff to the new git-primer section of committer guide
Vendor branch managed belongs in the comitter guide, as it is relevant to
comitters and not to the larger community of people developing for FreeBSD,
which the developer's guide more genereal development.
2021-03-16 15:30:54 -06:00
Warner Losh
a2fbd7a750 Remove svn vendor import information.
It is no longer relevant to the day-to-day operations of the project. It's all
done with git now. We have the old content in the doc repo should someone need
this information in the future.
2021-03-16 14:43:40 -06:00
Warner Losh
35c2ff4910 Remove sparc64 trademark
We don't reference sparc64 in either of these chapters, so remove it from the
trademark list.
2021-03-16 14:31:54 -06:00
Li-Wen Hsu
b6c72f65a8
Fix weird generated format
Approved by:	carlavilla (implicitly)
2021-03-16 19:10:07 +08:00
Ka Ho Ng
872e509c38 Add committer entries for Ka Ho Ng <khng>
Steps 1-4 from the Committer's guide:
  * Add entries for Ka Ho Ng <khng>
  * Add PGP key

Reviewed by:		philip
Approved by:		philip (mentor)
Differential Revision:	https://reviews.freebsd.org/D29282
2021-03-16 14:08:55 +08:00
Warner Losh
6b6cb62f7d handbook: update mirrors to include git
Pull most of URLs.md from my freebsd-git-docs github repo and reformat to
asciidoc. Copy some of the existing svn info and retarget it to Git.

Submissions on github from: lwshu@, 0mp@, Alexander Richardson, Ryan Libby,
	Ceri Davies, Joseph Mingrone
Feedback from: Pau Amma, emaste@
Sponsored by: Netflix, Inc
Differential Revision:	https://reviews.freebsd.org/D29252
2021-03-14 17:47:37 -06:00
Sergio Carlavilla Delgado
2a617095b1 Upgrade informacion about the new git procedures.
Upgrade some information about the new git procedures
in cutting-edge chapter.

Upgrade the bsd family tree to point to git instead of svn

PR:             254132
Submitted by:   tech-lists (at) zyxst.net
2021-03-14 18:06:17 +01:00
Li-Wen Hsu
a9a9e66105
Use correct syntax markup for shell
Approved by:	carlavilla
2021-03-14 20:08:55 +08:00
Fernando Apesteguía
bf79ecf9cf [phb:security] Fix vuln.xml testing procedure
Summary:
In [[https://svnweb.freebsd.org/ports?view=revision&revision=562203|r562203]]
and [[https://svnweb.freebsd.org/ports?view=revision&revision=562203|r562204]] the vuln.xml file was splitted by year.

As stated in the commit message, `pkg(8) audit` does not support entities and hence,
we need to use the vuln-flat.xml file to test changes to the port.

Test Plan:
* Try something like this:

```
$ pkg audit -f ./vuln.xml gitea-1.13.4
pkg: Syntax error while parsing vulnxml
pkg: cannot process vulnxml
```

and then:

```
$ pkg audit -f ./vuln-flat.xml gitea-1.13.4
0 problem(s) in 0 installed package(s) found.
```

After the patch:

* `igor` clean
* The documentation is rendered properly.

Reviewers: 0mp, gbe

Differential Revision: https://reviews.freebsd.org/D29219
2021-03-12 13:45:48 +01:00
Ryan Libby
9c5b7a9157 Update PGP key for rlibby@ 2021-03-11 00:17:40 -08:00
Bryan Drewery
1a388b141d Update my subkey signature 2021-03-10 21:57:48 -08:00
Gordon Bergling
6e71c6428d Handbook: Security -> Doas
Add an actual headline for the small chapter.
2021-03-06 13:14:56 +01:00
Gordon Bergling
180b5eb083 Handbook: Add a small chapter about doas as an alternative to sudo
doas is a viable alternative to sudo, so it is worth to be
mentioned in our handbook.

Reviewed by:	0mp (early version)
Differential Revision:	https://reviews.freebsd.org/D28483
2021-03-06 13:02:42 +01:00
Pau Amma
adbe84dccb porters-handbook: Fix typos
Reviewed by:	ygy
Differential Revision:	https://reviews.freebsd.org/D29096
2021-03-05 21:55:56 +01:00
Chris Rees
7c3a8149fd Keep references to stable (12) up to date
This adds an entity, betarel-current-major which refers to the
latest -STABLE

Reviewed by:		gjb
Differential Revision:	https://reviews.freebsd.org/D29057
2021-03-05 18:31:20 +00:00
Dmitri Goutnik
9a1d65ec41 porters-handbook: update Go porting notes for D28184
Approved by:		crees (doc)
Differential Revision:	https://reviews.freebsd.org/D28789
2021-03-04 11:32:05 -05:00
Chris Rees
4d8cfb575f We have an RC script for xdm nowadays 2021-03-03 23:54:16 +00:00
Sergio Carlavilla Delgado
1c7144822f Fix typo and renegade parenthesis.
Fix typo and renegade parenthesis in ZFS and virtualization
chapters in the handbook.

PR:         253264
Patch by:   panden(at)gmail.com
2021-03-03 22:10:39 +01:00
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