diff options
Diffstat (limited to 'static/freebsd/man7/development.7 3.html')
| -rw-r--r-- | static/freebsd/man7/development.7 3.html | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/static/freebsd/man7/development.7 3.html b/static/freebsd/man7/development.7 3.html new file mode 100644 index 00000000..34947732 --- /dev/null +++ b/static/freebsd/man7/development.7 3.html @@ -0,0 +1,128 @@ +<table class="head"> + <tr> + <td class="head-ltitle">DEVELOPMENT(7)</td> + <td class="head-vol">Miscellaneous Information Manual</td> + <td class="head-rtitle">DEVELOPMENT(7)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">development</code> — + <span class="Nd">introduction to <span class="Ux">FreeBSD</span> development + process</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp"><span class="Ux">FreeBSD</span> development is split into three + major subprojects: doc, ports, and src. Doc is the documentation, such as + the <span class="Ux">FreeBSD</span> Handbook. To read more, see:</p> +<p class="Pp"><a class="Lk" href="https://docs.FreeBSD.org/en/books/fdp-primer/">https://docs.FreeBSD.org/en/books/fdp-primer/</a></p> +<p class="Pp">Ports, described further in <a class="Xr">ports(7)</a>, are the + way to build, package, and install third party software. To read more, + see:</p> +<p class="Pp"><a class="Lk" href="https://docs.FreeBSD.org/en/books/porters-handbook/">https://docs.FreeBSD.org/en/books/porters-handbook/</a></p> +<p class="Pp">The last one, src, revolves around the source code for the base + system, consisting of the kernel, and the libraries and utilities commonly + called the world.</p> +<p class="Pp">The Committer's Guide, describing topics relevant to all + committers, can be found at:</p> +<p class="Pp"><a class="Lk" href="https://docs.freebsd.org/en/articles/committers-guide/">https://docs.freebsd.org/en/articles/committers-guide/</a></p> +<p class="Pp"><span class="Ux">FreeBSD</span> src development takes place in the + project-hosted Git repository, located at:</p> +<p class="Pp"><a class="Lk" href="https://git.FreeBSD.org/src.git">https://git.FreeBSD.org/src.git</a></p> +<p class="Pp">The push URL is:</p> +<p class="Pp"><a class="Lk" href="ssh://git@gitrepo.FreeBSD.org/src.git">ssh://git@gitrepo.FreeBSD.org/src.git</a></p> +<p class="Pp">There is also a list of public, read-only Git mirrors at:</p> +<p class="Pp"><a class="Lk" href="https://docs.FreeBSD.org/en/books/handbook/mirrors/#external-mirrors">https://docs.FreeBSD.org/en/books/handbook/mirrors/#external-mirrors</a></p> +<p class="Pp">The ‘<code class="Li">main</code>’ Git branch + represents CURRENT; all changes are first committed to CURRENT and then + usually cherry-picked back to STABLE, which refers to Git branches such as + ‘<code class="Li">stable/14</code>’. Every few years a new + STABLE is branched from CURRENT, with an incremented major version number. + Releases are then branched off STABLE and numbered with consecutive minor + numbers such as ‘<code class="Li">releng/14.3</code>’</p> +<p class="Pp">The layout of the source tree is described in its + <span class="Pa">README.md</span> file. Build instructions can be found in + <a class="Xr">build(7)</a> and <a class="Xr">release(7)</a>. Kernel + programming interfaces (KPIs) are documented in section 9 manual pages; use + ‘<code class="Li">apropos -s 9 .</code>’ for a list. + Regression test suite is described in <a class="Xr">tests(7)</a>. For coding + conventions, see <a class="Xr">style(9)</a>.</p> +<p class="Pp">To ask questions regarding development, use the mailing lists, + such as freebsd-arch@ and freebsd-hackers@:</p> +<p class="Pp"><a class="Lk" href="https://lists.FreeBSD.org">https://lists.FreeBSD.org</a></p> +<p class="Pp">To get your patches integrated into the main + <span class="Ux">FreeBSD</span> repository use Phabricator; it is a code + review tool that allows other developers to review the changes, suggest + improvements, and, eventually, allows them to pick up the change and commit + it:</p> +<p class="Pp"><a class="Lk" href="https://reviews.FreeBSD.org">https://reviews.FreeBSD.org</a></p> +<p class="Pp">Or Github:</p> +<p class="Pp"><a class="Lk" href="https://github.com/freebsd">https://github.com/freebsd</a></p> +<p class="Pp">To check the latest <span class="Ux">FreeBSD</span> build and test + status of CURRENT and STABLE branches, the continuous integration system is + at:</p> +<p class="Pp"><a class="Lk" href="https://ci.FreeBSD.org">https://ci.FreeBSD.org</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/usr/src/CONTRIBUTING.md</span></dt> + <dd><span class="Ux">FreeBSD</span> contribution guidelines</dd> + <dt><span class="Pa">/usr/src/tools/tools/git/git-arc.sh</span></dt> + <dd>Phabricator review tooling</dd> + <dt><span class="Pa">/usr/ports/devel/freebsd-git-arc</span></dt> + <dd>Phabricator review tooling as a port</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<p class="Pp">Apply a patch from Github pull #1234, using + <span class="Pa">devel/gh</span>:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">gh pr checkout 1234</code></div> +<p class="Pp">Apply a patch from Phabricator review D1234, using + <a class="Xr">git-arc(1)</a>:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">git arc patch -c D1234</code></div> +<p class="Pp">Apply a manually downloaded <a class="Xr">git-format-patch(1)</a>, + <span class="Pa">draft.patch</span>, from Bugzilla or mail:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">git am draft.patch</code></div> +<p class="Pp">Apply a manually downloaded patch, + <span class="Pa">draft.diff</span>, from Bugzilla or mail:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">git apply draft.diff</code></div> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">git(1)</a>, <a class="Xr">git-arc(1)</a>, + <a class="Xr">witness(4)</a>, <a class="Xr">build(7)</a>, + <a class="Xr">hier(7)</a>, <a class="Xr">ports(7)</a>, + <a class="Xr">release(7)</a>, <a class="Xr">tests(7)</a>, + <a class="Xr">locking(9)</a>, <a class="Xr">style(9)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">development</code> manual page was originally + written by <span class="An">Matthew Dillon</span> + <<a class="Mt" href="mailto:dillon@FreeBSD.org">dillon@FreeBSD.org</a>> + and first appeared in <span class="Ux">FreeBSD 5.0</span>, December 2002. It + was since extensively modified by <span class="An">Eitan Adler</span> + <<a class="Mt" href="mailto:eadler@FreeBSD.org">eadler@FreeBSD.org</a>> + to reflect the repository conversion from + <a class="Lk" href="https://www.nongnu.org/cvs/">CVS</a> to + <a class="Lk" href="https://subversion.apache.org/">Subversion</a>. It was + rewritten from scratch by <span class="An">Edward Tomasz Napierala</span> + <<a class="Mt" href="mailto:trasz@FreeBSD.org">trasz@FreeBSD.org</a>> + for <span class="Ux">FreeBSD 12.0</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">September 24, 2025</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |