aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-09-091-1144/+1192
|
* Committer's: Change the way to install commit template hookYasuhiro Kimura2023-09-071-2/+19
| | | | | | | | | | | | | | | | | | | Currently commit message template hook is installed as following. * The one for src repository is also used for doc and ports. * The file is downloaded through web interface (https://cgit.freebsd.org/) and installed under .git/hooks. However, * Both doc and ports repositories have their own hooks inside them. So it is obviously better to use them than using the one for src repository. * For src repository committer need to download and install hook file each time it is updated. So change the way to install commit message template hook as following. * For doc and src repository, create symbolic link under '.git/hooks' that points to real hook file. * For ports repository. set the path to look for hooks to '.hooks'. This is because ports repository also provides some other hooks and creating symbolic link for each of them is bothersome. PR: 273574
* Committer's guide: Review gpg.conf optionsMatteo Riondato2023-09-071-8/+4
| | | | | | | | Discussed by email with philip@ Changed the original patch to add the 'link' macro PR: 262174
* committers-guide: Clarify changes made in 98565318b6Ceri Davies2023-08-281-2/+2
|
* Committer's Guide: four tiers: heading levelsGraham Perrin2023-08-151-4/+4
| | | | | | | | | | | | https://docs.freebsd.org/en/articles/committers-guide/#_statement_of_general_intent Level 3 section title for tiers 1, 2, and 3, and for the unsupported tier. Reviewed-by: imp Approved-by: emaste Pull-request: https://github.com/freebsd/freebsd-doc/pull/188 Closes: https://github.com/freebsd/freebsd-doc/pull/188
* Committer's Guide: Fix a typoSoobin Rho2023-08-121-1/+1
| | | | Pull Request: https://github.com/freebsd/freebsd-doc/pull/246
* Committer's Guide: indicate that ${repo} must be expandedEd Maste2023-07-211-0/+5
| | | | | | | | Reviewed by: lwhsu Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D41065 fixup turn note into note
* Committer's Guide: suggest skipping section, not whole documentEd Maste2023-07-181-1/+1
| | | | | | | | 5.2.8. Managing Local Changes said "you can stop reading now" if one has no local changes, but later sections are still important (MFCs, Vendor Imports). Sponsored by: The FreeBSD Foundation
* Remove "either" where only one case is shownEd Maste2023-07-181-1/+1
| | | | | | PR: 264751 Fixes: 1e28a7874537 ("git primer: Fix two errors") Sponsored by: The FreeBSD Foundation
* Committer's Guide: document Co-authored-byEd Maste2023-07-171-0/+4
| | | | | | Reviewed by: imp, jhb Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D41060
* documentation/content: Replace Poudriere with poudriereMuhammad Moinur Rahman2023-07-161-2/+2
| | | | | | - poudriere authors bapt and bdrewary prefers to write it as poudriere instead of Poudriere. Update all the documentation to reflect the same. - While I am here fix EOL and trailing spaces.
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-07-151-426/+427
|
* Committer's guide: add an "Approved by" case used in portsEd Maste2023-06-211-0/+1
| | | | | | PR: 259385 Reviewed by: gerald Sponsored by: The FreeBSD Foundation
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-06-201-434/+436
|
* committers-guide: make it clear that `Submitted by` is deprecatedEd Maste2023-05-221-1/+2
| | | | | | | | | | | Add (deprecated) in the first column. When mentioned only in prose in the second column it may be missed. Noticed by: rmacklem Reviewed by: jrtc27, lwhsu Event: Kitchener-Waterloo Hackathon 2023 Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D40196
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-05-211-1229/+1170
|
* Remove instances of "in order to" to ease readabilityBenedict Reuschling2023-05-181-2/+2
| | | | | | Chapter 11 of the FreeBSD Documentation Project Primer states that language should be clear, short, and simple. This phrasing rarely helps with that and can be cut to a single "to" in pretty much all instances.
* Git and related corrections and improvementsGraham Perrin2023-05-161-107/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | df53ae0fdd98e9452095ac2fdaf95fcfac8c9c7f (2023-04-23): * removed portsnap * encourages use of Git. This round of Git-oriented corrections and changes is, essentially, timed to precede creation of the releng/14.0 branch. Not intended to be comprehensive. Attention to things such as: * HEAD (not a branch) and main (branch) * main (not a branch) and mainline * repositories (there are three) * ports latest, current (not CURRENT) and quarterly * FREEBSD-CURRENT and FREEBSD-STABLE * master * things that were relevant only around the time of migration to Git * markup * grammar. Under https://docs.freebsd.org/en/articles/committers-guide/#_rebasing_your_change_against_latest_freebsd_source_tree a list of items was misrepresented as a single paragraph with asterisk characters in its midst. Reviewed by: carlavilla, imp Approved by: imp Pull Request: https://github.com/freebsd/freebsd-doc/pull/182 Differential revision: https://reviews.freebsd.org/D40026
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-04-201-3151/+2271
|
* Committer's guide: Remove email sender specificationLorenzo Salvadore2023-04-071-1/+1
| | | | | | | | | Do not specify anymore that the email granting a commit bit is from core, since such emails are not sent by core for ports and doc commit bits: they are only for src. Approved by: carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D39447
* committers-guide: minor improvements to the EnglishCeri Davies2023-04-061-3/+3
|
* Committer's Guide … Git … MFC … Examples: noneGraham Perrin2023-04-021-2/+0
| | | | | | | | | | | | | | The 'Examples' subheading that is currently at https://docs.freebsd.org/en/articles/committers-guide/#_examples has no subtext. Hiding the subheading was considered. Instead, it is deleted. https://bugs.freebsd.org/264080 PR: 264080 Approved by: imp Differential Revision: https://reviews.freebsd.org/D39384
* git-primer: Update how to rebase a vender branch mergeWarner Losh2023-03-311-36/+63
| | | | | | | | | | | | | | | Update the vendor branch merge section to include the missing commands and hopefully to make it more clear. Switch to using bogus branch names that will stand out on purpose. This rework 'play' tested on the lua branch merge, which needed dozens of rebasing... Also, indent by one space the conflict section so as to not confuse automated tools (or me) that it's a real conflict that needs to be resolved. Sponsored by: Netflix
* committers guide: remove "MFC with" tagEd Maste2023-03-212-9/+0
| | | | | | | | "Fixes" and "MFC with" are used for approximately the same purpose, but the former is standard in the Git-based deveopment world. Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D39190
* Committer guide: Correct the pacakge names of GCC12 for cross compilingLi-Wen Hsu2023-03-191-3/+3
| | | | | | | | Use the newly added syntax of the pacakge macro (in 1d899c1c6fc6). While here, fix some wording and typo spotted by Pau Amma. Differential Revision: https://reviews.freebsd.org/D39068
* Trademarks: Add Git, GitHub and GitLabLorenzo Salvadore2023-03-051-2/+2
| | | | | | | | | | | | | | | | | | | | | - Git: add the trademark line suggested by https://git-scm.com/about/trademark - GitLab: add the trademark line requested by https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/brand/brand-activation/trademark-guidelines/ - GitHub: it is a registered trademark according to the following links: https://github.com/logos https://docs.github.com/en/site-policy/github-terms/github-open-source-applications-terms-and-conditions#githubs-logos https://tmsearch.uspto.gov/bin/showfield?f=doc&state=4808:xvjz5y.2.4 Apply the newly introduced trademarks to the Committer's guide. Also add a TM symbol immediately after the first reference to the GitLab Name as requested by https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/brand/brand-activation/trademark-guidelines/ Approved by: doceng (carlavilla) Differential Revision: https://reviews.freebsd.org/D38916
* committers-guide: spell checksCeri Davies2023-03-051-7/+7
|
* committers-guide: Add section on range of compilersWarner Losh2023-02-281-1/+61
| | | | | | | | | Document the range of compilers the project uses for building, CI and external toolchain support, and try to assign the proper level of effort developers should go to for each of them. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D38709
* git-primer: Trim old subversion infoWarner Losh2023-02-211-394/+4
| | | | | | | | It's been a couple of years since we transitioned to git. Remove this transition information. Should people really need it, it will be in the doc git repo history. Make minor tweaks to some adjacent material. Sponsored by: Netflix
* tiers: Remove obsolete languageWarner Losh2023-02-211-4/+0
| | | | | | | | amd64 is none of these things, so just remove the 'justifcation' sentence. It's wrong and fixing it wouldn't add any value. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D38708
* git primer: Fix two errorsWarner Losh2023-01-291-8/+1
| | | | | | | | | | | | | Recommend pushing HEAD:main in the vendor branch docs, since that's always going to be right. Stop recommending people set push.default to 'freebsd'. It's an enumerated value that's not a branch name. Most likely correct value here is 'upstream'. However, there's enough people with asymetrical setups that I'm just removing the setup rather than describe all the special cases. Sponsored by: Netflix
* git primer: Fix push commandWarner Losh2023-01-281-1/+1
| | | | | | | | | The instructions leave one on the merge_results branch, not on main, so pushing the remote repo won't work. You have to specifically add the branch name on the push for that to work. Noticed by: sjg Sponsored by: Netflix
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-01-211-604/+616
|
* Miscellaneous small changes to the Committer's Guide.Pau Amma2023-01-031-20/+28
| | | | | | | | | | | PR below plus a few more I spotted while working on it. While there, check nearby URLs still work and use https:. PR: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261812 Reviewed by: carlavlla, gjb, philip Approved by: carlavilla (mentor), gjb (mentor, earlier version) Differential Revision: https://reviews.freebsd.org/D37091
* license: Move to BSD-2-Clause and drop -FreeBSDWarner Losh2022-12-151-1/+1
| | | | | | | | | | | | | BSD-2-Clause-FreeBSD has been deprecated as a separate license. https://tools.spdx.org/app/check_license/ says that the text matches BSD-2-Cluase. There's some history behind the mismatch, but it's best to move forward now that our preferred license matches BSD-2-Clause. Sponsored by: Netflix Reviewed by: pauamma, andrew Differential Revision: https://reviews.freebsd.org/D37714
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-10-161-2/+36
|
* Add JetBrains to the committers perksMuhammad Moinur Rahman2022-10-091-10/+22
| | | | | | | | | | | JetBrains is offering 100 licenses yearly for FreeBSD committers. Add it to the Committer's Guide as perks. - Remove trailing whitespaces - Remove trailing blank lines PR: 264764 Approved by: carlavilla (mentor)
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-10-011-1019/+1024
|
* [doc-en][articles/committers-guide] Fix subsectionFernando Apesteguía2022-09-301-0/+1
| | | | | | Add a blank line after "====" subsection. The English version is rendered well anyway, but translations get the wrong string mixing the title and the content of the translation.
* doc: Add source .po files for translationsDanilo G. Baio2022-08-071-0/+9307
| | | | | | | | | | | | | | | | | | This helps the Weblate translation workflow and offline translations through .po files, it's important to update these files constantly. The goal here is to have a semi-automated translation workflow; Weblate will pull updates automatically from the main repository and commit translations to another repository. Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. $ ./tools/update_translate_template.sh documentation Anyway, I'll keep doing this periodically. Discussed with: doceng
* Fix typos in new account creation procedureSergio Carlavilla Delgado2022-06-261-1/+1
| | | | | PR: 264562 Submitted by: Graham Perrin <grahamperrin (AT) gmail.com>
* Upgrade PGP & GPG (No Starch Press) to correct linkSergio Carlavilla Delgado2022-06-241-1/+1
| | | | | PR: 264409 Submitted by: Graham Perrin <grahamperrin (AT) gmail.com>
* Update pkg_version reference to pkg version in comitters guidePau Amma2022-06-241-1/+1
| | | | | Approved by: carlavilla@, bapt@ Differential Revision: https://reviews.freebsd.org/D35273
* Spell Google correctly.Benedict Reuschling2022-06-051-1/+1
|
* articles/committers-guide: address verbiageJason Helfman2022-05-311-2/+2
| | | | Submitted by: pauamma@gundo.com
* articles/committers-guide: add Exim MTA instructions for smtp.freebsd.orgJason Helfman2022-05-251-0/+44
| | | | PR: 262742 (based on)
* committers-guide: fix the Phabricator wiki page addressGraham Perrin2022-05-211-1/+1
| | | | | | Reviewed by: dbaio, Pau Amma Pull Request: https://github.com/freebsd/freebsd-doc/pull/69 Differential Revision: https://reviews.freebsd.org/D35224
* Committers-guide port section: remove addportLuca Pizzamiglio2022-05-091-6/+19
| | | | | | | | | | | | | | | Summary: The script addport is not working anymore, it's based on SVN and it's quite hard to port it to git. Before its removal, we want to remove its references in the documentation. Related bugzilla entry: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261378 Reviewers: tcberner, se Differential Revision: https://reviews.freebsd.org/D35071
* Committer's guide: Fix about (re)moving portsLorenzo Salvadore2022-05-071-1/+1
| | | | | | | | | | | | Summary: - Move consideration about security vulnerabilities from instructions for removing ports to instructions for moving ports. - Reword the above consideration to take into account the splitting of vuln.xml into one file per year. Reviewed by: portmgr (rene), Pau Amma <pauamma@gundo.com> Approved by: docs (carlavilla), gerald (mentor) Differential Revision: https://reviews.freebsd.org/D35112
* Remove wollman@ from Who's who section of committer's guideSergio Carlavilla Delgado2022-05-031-4/+0
| | | | | | | Removed with the wollman@ approval PR: 261894 Submitted by: PauAmma <pauamma (AT) gundo.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-17 23:54:01 +0000