os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Start to update the committer's guide with git information

Browse source 
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.
This commit is contained in:
Warner Losh 2021-02-04 10:21:04 -07:00
parent e73763e350
commit b3f6ba6ff5
1 changed files with 26 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
documentation/content/en/articles/committers-guide/_index.adoc
View file

@ -51,11 +51,11 @@ toc::[]
|_SMTP Host_
|`smtp.FreeBSD.org:587` (see also <<smtp-setup>>).
|`_src/_` Subversion Root
|`svn+ssh://repo.FreeBSD.org/base` (see also <<svn-getting-started-base-layout>>).
|`_src/_` Git Repository
|`ssh://git@gitrepo.FreeBSD.org/src.git` (see also <<git-getting-started-base-layout>>).
|`_doc/_` Subversion Root
|`svn+ssh://repo.FreeBSD.org/doc` (see also <<svn-getting-started-doc-layout>>).
|`_doc/_` Git Repository
|`ssh://git@gitrepo.FreeBSD.org/doc.git` (see also <<git-getting-started-doc-layout>>).
|`_ports/_` Subversion Root
|`svn+ssh://repo.FreeBSD.org/ports` (see also <<svn-getting-started-ports-layout>>).
@ -238,12 +238,14 @@ Committers are encouraged to seek review for their work as part of the normal de
New committers are assumed to already be familiar with the basic operation of Subversion. If not, start by reading the http://svnbook.red-bean.com/[Subversion Book].
This section is relevant only for the ports tree. Information on Git is being worked into the handbook and other documents. A draft version can be found at https://github.com/bsdimp/freebsd-git-docs/blob/main/SUMMARY.adoc
[[svn-intro]]
=== Introduction
The FreeBSD source repository switched from CVS to Subversion on May 31st, 2008. The first real SVN commit is __r179447__.
The FreeBSD source repository switched from CVS to Subversion on May 31st, 2008. The first real SVN commit is __r179447__. The source repository switched from Subversion to Git on December 23rd, 2020. The last real svn commit is __r368820__. The first real git commit hash is __5ef5f51d2bef80b0ede9b10ad5b0e9440b60518c__
The FreeBSD `doc/www` repository switched from CVS to Subversion on May 19th, 2012. The first real SVN commit is __r38821__.
The FreeBSD `doc/www` repository switched from CVS to Subversion on May 19th, 2012. The first real SVN commit is __r38821__. The documentation repository switched from Subversion to Git on December 8th, 2020. The last SVN commit is __r54737__. The first real git commit hash is __3be01a475855e7511ad755b2defd2e0da5d58bbe__.
The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, 2012. The first real SVN commit is __r300894__.
@ -307,34 +309,36 @@ This is the simplest method, but it is hard to tell just yet how much load it wi
The `svn diff` does not require access to the server as SVN stores a reference copy of every file in the working copy. This, however, means that Subversion working copies are very large in size.
====
[[svn-getting-started-base-layout]]
[[git-getting-started-base-layout]]
==== `RELENG_*` Branches and General Layout
In `svn+ssh://repo.freebsd.org/base`, _base_ refers to the source tree. Similarly, _ports_ refers to the ports tree, and so on. These are separate repositories with their own change number sequences, access controls and commit mail.
In `ssh://gitrepo.freebsd.org/src.git`, _src_ refers to the source tree. Similarly, _ports_ refers to the ports tree, and so on. These are separate repositories with their own change number sequences, access controls and commit mail.
For the base repository, HEAD refers to the -CURRENT tree. For example, [.filename]#head/bin/ls# is what would go into [.filename]#/usr/src/bin/ls# in a release. Some key locations are:
For the src repository, `main` refers to the -CURRENT tree. For example, [.filename]#head/bin/ls# is what would go into [.filename]#/usr/src/bin/ls# in a release. Some key branches are:
* _/head/_ which corresponds to `HEAD`, also known as `-CURRENT`.
* _/stable/n_ which corresponds to `RELENG_n`.
* _/releng/n.n_ which corresponds to `RELENG_n_n`.
* _/release/n.n.n_ which corresponds to `RELENG_n_n_n_RELEASE`.
* _/vendor*_ is the vendor branch import work area. This directory itself does not contain branches, however its subdirectories do. This contrasts with the __stable__, _releng_ and _release_ directories.
* _/projects_ and _/user_ feature a branch work area. As above, the _/user_ directory does not contain branches itself.
* _main_ which corresponds to `HEAD`, also known as `-CURRENT`.
* _stable/n_ which corresponds to `RELENG_n`.
* _releng/n.n_ which corresponds to `RELENG_n_n`.
* _release/n.n.n_ which corresponds to `RELENG_n_n_n_RELEASE`.
* _vendor*_ is the vendor branch import work area.
[[svn-getting-started-doc-layout]]
[[git-getting-started-doc-layout]]
==== FreeBSD Documentation Project Branches and Layout
In `svn+ssh://repo.freebsd.org/doc`, _doc_ refers to the repository root of the source tree.
In `ssh://gitrepo.freebsd.org/doc.git`, _doc_ refers to the repository of the documentation tree.
In general, most FreeBSD Documentation Project work will be done within the [.filename]#head/# branch of the documentation source tree.
In general, most FreeBSD Documentation Project work will be done within the `main` branch of the documentation source tree.
FreeBSD documentation is written and/or translated to various languages, each in a separate directory in the [.filename]#head/# branch.
FreeBSD documentation is written and/or translated to various languages, each in a separate directory in the `main` branch.
Each translation set contains several subdirectories for the various parts of the FreeBSD Documentation Project. A few noteworthy directories are:
* _/articles/_ contains the source code for articles written by various FreeBSD contributors.
* _/books/_ contains the source code for the different books, such as the FreeBSD Handbook.
* _/htdocs/_ contains the source code for the FreeBSD website.
* _documentation/_ contains all the source code for the documentation part of the tree.
* _documentation/content/LANG/articles/_ contains the source code for articles written by various FreeBSD contributors.
* _documentation/content/LANG/books/_ contains the source code for the different books, such as the FreeBSD Handbook.
* _website/_ contains the source code for the FreeBSD website.
LANG above is the two character language code. All document source is encoded using Unicode.
[[svn-getting-started-ports-layout]]
==== FreeBSD Ports Tree Branches and Layout