aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
...
* [committers-guide] Update src branches informationFernando Apesteguía2021-04-211-2/+2
| | | | | | | | | | | | | | | 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
* committers-guide: Fix indentation of commit message examplesMateusz Piotrowski2021-04-201-10/+10
|
* committers-guide: Remove "Submitted by" from examplesMateusz Piotrowski2021-04-201-3/+4
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D29868
* committers-guide: Discourage use of Submitted byMateusz Piotrowski2021-04-201-2/+2
| | | | The use of "Submitted by" is discouraged in all the source trees now.
* committers-guide: Bring back MFH metadata fieldMateusz Piotrowski2021-04-201-0/+3
| | | | | | | | | 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
* articles/committers-guide: Document change in MFH policyMateusz Piotrowski2021-04-201-59/+1
| | | | | | | | 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
* articles/committers-guide: Update "MFC with" descriptionMateusz Piotrowski2021-04-201-1/+1
| | | | We use Git hashes now, not revision numbers.
* Clarify that the vendor merge commits should have proper commit messagesMark Johnston2021-04-191-0/+1
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D29745
* articles/committers-guide: fix README linkFernando Apesteguía2021-04-181-1/+1
| | | | | | | | | | 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
* [Committers Guide] Fix paths in Steps for New CommittersFernando Apesteguía2021-04-181-2/+2
| | | | | | | | | | | | * 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
* Provide a one-liner for the "Fixes" commit key wordMateusz Piotrowski2021-04-171-1/+1
|
* Capitalize words properlyMateusz Piotrowski2021-04-171-44/+44
| | | | | | 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.
* Correct the cgit repository URL for ports tree.Ryusuke SUZUKI2021-04-171-1/+1
|
* Do not recommend filling "Fixes:" with SVN revisionsMateusz Piotrowski2021-04-161-2/+1
| | | | The ports tree has transitioned to Git already.
* Add rsync.net percs in FreeBSD Committer's GuideMuhammad Moinur Rahman2021-04-121-0/+7
|
* Fix a typo and some word tagging.Marc Fonvieille2021-04-111-5/+5
|
* Add missing whitespace and correct tagging to one command.Marc Fonvieille2021-04-111-1/+1
|
* [committers-guide] Add missing wordFernando Apesteguía2021-04-101-1/+1
| | | | | | | In section 5.8 Collaborating with others. Approved by: gbe Differential Revision: https://reviews.freebsd.org/D29693
* Rough draft on collaboration using githubGeorge V. Neville-Neil2021-04-091-1/+7
|
* Address points brought up by bsdimpGeorge V. Neville-Neil2021-04-091-10/+10
|
* Add langauge and other simple updates from uqsGeorge V. Neville-Neil2021-04-091-22/+20
|
* Rough draft on collaboration using githubGeorge V. Neville-Neil2021-04-091-0/+87
|
* Add OpenSMTPD example for sending mail through FreeBSD mxsMuhammad Moinur Rahman2021-04-061-0/+24
| | | | | | | | 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
* Remove the subversion section from the committer's guide.Warner Losh2021-04-061-842/+6
| | | | | | | | | 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
* Committers Guide: fix some URLs and mention our GitHub mirror.Rene Ladan2021-04-061-2/+3
| | | | Submitted by: lwhsu
* Committers Guide: update the ports-specific sections to git.Rene Ladan2021-04-061-213/+26
| | | | | | | | | | | | | | - 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
* Upgrade committers-guide and freebsd-releng with the new doc tech.Sergio Carlavilla Delgado2021-03-201-1/+1
| | | | | Upgrade committers-guide and freebsd-releng to show the new documentation tech - Hugo/AsciiDoctor
* Minor word smithingWarner Losh2021-03-191-6/+7
| | | | | | Fix a few typoes, grammar errors, wrong word choices, and a bad url. Submitted by: Pau Amma
* Fix typos, style and fix AsciiDoc syntax in bsdl-gpl, building products and ↵Sergio Carlavilla Delgado2021-03-191-559/+867
| | | | | | | | | | 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.
* spdx: document usageWarner Losh2021-03-191-0/+14
| | | | | | | | | 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
* Lots of improvements.Warner Losh2021-03-191-63/+53
| | | | | | | 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).
* git: add FAQWarner Losh2021-03-181-0/+410
| | | | | | Add in the FAQ from the github docs I did for the transition. Submissions from: rpokala@, jrm@, Marc Branchaud and "mirror176".
* MFC: tweak the langaugeWarner Losh2021-03-181-2/+1
| | | | | | | 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.
* MFC: update advice on MFC practicesWarner Losh2021-03-181-34/+38
| | | | | | 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.
* Another round of typosWarner Losh2021-03-181-7/+7
| | | | Submitted by: Pau Amma
* Wording improvementsWarner Losh2021-03-171-3/+4
| | | | | | | Describe how to collapse multiple MFCs better. Use consistent punctuation. fix some typos. Submitted by: Pau Amma
* Improve text in several waysWarner Losh2021-03-171-34/+37
| | | | | | | Fix typos, improve wording, remove redundantly repetitive words, fix punctuation and grammer errors. Submitted by: Pau Amma
* committer handbook: Fix typos and reformatWarner Losh2021-03-171-70/+50
| | | | | | | | 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
* Fix typo in committers guideBenjamin Kaduk2021-03-171-1/+1
|
* xxx: remove xxxWarner Losh2021-03-171-4/+2
| | | | Remove a couple of links that I didn't go back and fix before committing.
* Update vendor import with suggestionsWarner Losh2021-03-171-16/+17
| | | | | | | | | 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@
* Add the git miniprimerWarner Losh2021-03-171-0/+424
| | | | | | | | 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
* Committer's Guide: list the new commits mailing lists to replace svn onesLi-Wen Hsu2021-03-171-1/+1
| | | | Approved by: carlavilla (implicitly)
* Document what Signed-off-by meansWarner Losh2021-03-171-0/+4
| | | | | 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.
* Merge in the migration from subversion / githubWarner Losh2021-03-171-7/+268
| | | | | | | 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
* Alternative formatting on freebsd/developer/* blocksKa Ho Ng2021-03-171-2/+2
| | | | | | | | | | 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
* Move the MFC doc from my freebsd-git-docs repo to handbookWarner Losh2021-03-171-0/+494
| | | | | | | | 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
* Two more typos I made while fixing the last typos.Warner Losh2021-03-171-2/+2
| | | | Noticed by: Pau Amma
* Fix more typos from the original github docsWarner Losh2021-03-171-31/+29
| | | | | | | | 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)
* git: Move vendor branch stuff to the new git-primer section of committer guideWarner Losh2021-03-161-0/+228
| | | | | | 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.
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-02 07:59:27 +0000