Commit Graph

64 Commits

Author SHA1 Message Date
Fernando Apesteguía 0eb1ef29d9 [committers-guide] Fix typo
s/relese/release

Approved by: 0mp
Differential Revision: https://reviews.freebsd.org/D29889
2021-04-22 08:24:48 +02:00
Fernando Apesteguía 69fe0eea04 [committers-guide] Consistent use of Subversion
Majority of the uses capitalize the first letter. Let the rest do the same.

Approved by: 0mp
Differential Revision: https://reviews.freebsd.org/D29888
2021-04-22 08:22:52 +02:00
Fernando Apesteguía 8f3c366fd2 [committers-guide] Update src branches information
Summary:
s/SVN/Git
s/head/main

Although there are other branches in the repo (like vendor/ or releng/), if they
were not considered noteworthy before, I choose not make them notheworthy now.

Test Plan: * Renders OK.

Reviewers: 0mp, gbe

Differential Revision: https://reviews.freebsd.org/D29886
2021-04-21 18:39:58 +02:00
Mateusz Piotrowski 5755cad0f0 committers-guide: Fix indentation of commit message examples 2021-04-20 17:45:54 +02:00
Mateusz Piotrowski bcd1bb7a20 committers-guide: Remove "Submitted by" from examples
Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D29868
2021-04-20 17:45:19 +02:00
Mateusz Piotrowski ea68d93d5f committers-guide: Discourage use of Submitted by
The use of "Submitted by" is discouraged in all the source trees now.
2021-04-20 17:11:49 +02:00
Mateusz Piotrowski a527f32556 committers-guide: Bring back MFH metadata field
The MFH field is still useful to note that the commit is going to be
merged into a quarterly branch.

Reported by:	mat
Reviewed by:	mat
Differential Revision: https://reviews.freebsd.org/D29862
2021-04-20 14:56:44 +02:00
Mateusz Piotrowski ceee1def00 articles/committers-guide: Document change in MFH policy
Merging commits into the quarterly branch no longer requires an explicit
approval [1]. Let's remove outdated documentation and leave a note
explaining that there is no need for an explicit approval to MFH.

 [1] https://svnweb.freebsd.org/ports?view=revision&revision=556626
2021-04-20 12:14:58 +02:00
Mateusz Piotrowski 32abed26b2 articles/committers-guide: Update "MFC with" description
We use Git hashes now, not revision numbers.
2021-04-20 11:58:39 +02:00
Mark Johnston 6f71dc766b Clarify that the vendor merge commits should have proper commit messages
Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D29745
2021-04-19 15:54:02 -04:00
Fernando Apesteguía 745eae659f articles/committers-guide: fix README link
Current link in Committer's Guide for the README of the addkeys.sh script is
broken.

It should point to https://docs.freebsd.org/pgpkeys/README.

Approved by: 0mp (mentor)
Differential Revision: https://reviews.freebsd.org/D28928
2021-04-18 19:48:22 +02:00
Fernando Apesteguía f54d697cc3 [Committers Guide] Fix paths in Steps for New Committers
* There is no authors.toml but authors.adoc

* Add `doc` in the path as in the other steps to make explicit that we refer
  to the `doc` repository.

* s/shared/share in `src` repository:

Approved by: 0mp (mentor)
Differential Revision: https://reviews.freebsd.org/D28590
2021-04-18 17:48:14 +02:00
Mateusz Piotrowski a1bee259bb Provide a one-liner for the "Fixes" commit key word 2021-04-17 21:43:23 +02:00
Mateusz Piotrowski 84d56d3868 Capitalize words properly
I've capitalized "git" throughout the document where appropriate.
There are also some other words I've fixed like "github" and "gitlab",
but I've not reviewed the whole document looking for those.
2021-04-17 21:33:58 +02:00
Ryusuke SUZUKI dc2b9671b7 Correct the cgit repository URL for ports tree. 2021-04-17 11:42:53 +09:00
Mateusz Piotrowski e2e3e51b70 Do not recommend filling "Fixes:" with SVN revisions
The ports tree has transitioned to Git already.
2021-04-16 02:30:59 +02:00
Muhammad Moinur Rahman 9ad828a6e5 Add rsync.net percs in FreeBSD Committer's Guide 2021-04-12 20:04:23 +00:00
Marc Fonvieille 05b8a96ab7 Fix a typo and some word tagging. 2021-04-11 14:03:33 +02:00
Marc Fonvieille f86e96e387 Add missing whitespace and correct tagging to one command. 2021-04-11 13:54:17 +02:00
Fernando Apesteguía 0a8625aacc [committers-guide] Add missing word
In section 5.8 Collaborating with others.

Approved by: gbe
Differential Revision: https://reviews.freebsd.org/D29693
2021-04-10 21:18:58 +02:00
George V. Neville-Neil a0fbda3eef Rough draft on collaboration using github 2021-04-09 16:17:49 -04:00
George V. Neville-Neil 63584c7bba Address points brought up by bsdimp 2021-04-09 16:17:49 -04:00
George V. Neville-Neil 6982d9119d Add langauge and other simple updates from uqs 2021-04-09 16:17:49 -04:00
George V. Neville-Neil e47e964a9d Rough draft on collaboration using github 2021-04-09 16:17:49 -04:00
Muhammad Moinur Rahman 2c1a6b3977 Add OpenSMTPD example for sending mail through FreeBSD mxs
Adds an example on howto configure OpenSMPTD to forward
locally sent mails to FreeBSD.org mail servers.

Approved by:	crees, imp
Differential Revision:	https://reviews.freebsd.org/D29574
2021-04-06 20:54:18 +00:00
Warner Losh 4011c596fd Remove the subversion section from the committer's guide.
FreeBSD committers no longer need to know how to use subversion.
Remove the subversion primer from the committer's guide.
Add a VCS history section.

Suggestions by:		lwhsu@
Differential Revision:  https://reviews.freebsd.org/D29610
2021-04-06 13:45:16 -06:00
Rene Ladan c9b990e272 Committers Guide: fix some URLs and mention our GitHub mirror.
Submitted by:	lwhsu
2021-04-06 21:43:36 +02:00
Rene Ladan 3c9ef247f5 Committers Guide: update the ports-specific sections to git.
- Remove notes that the migration is in progress
- Remove old branch names and URLs
- Remove mention of psvn
- Remove section about re-adding a deleted port, git add will do the
  right thingn natively (most of the times).
- Remove section about repo-copies, git has no copy command.
- Simplify instructions for moving a port.
- Remove section about the mfh tool. Merges are now just cherry-picks.

Reviewed by:	crees, emaste, imp, lwhsu, mat
Differential Revision:	https://reviews.freebsd.org/D29450
2021-04-06 20:53:12 +02:00
Sergio Carlavilla Delgado 72a86c01df Upgrade committers-guide and freebsd-releng with the new doc tech.
Upgrade committers-guide and freebsd-releng to show the new
documentation tech - Hugo/AsciiDoctor
2021-03-20 19:34:29 +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 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
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
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