Adopt Developer Resources section
Signed-off-by: George Melikov <mail@gmelikov.ru>
This commit is contained in:
@@ -1,3 +1,6 @@
|
|||||||
|
Building ZFS
|
||||||
|
============
|
||||||
|
|
||||||
GitHub Repositories
|
GitHub Repositories
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
@@ -72,7 +75,7 @@ depends on your requirements.
|
|||||||
|
|
||||||
The remainder of this page focuses on the **in-tree** option which is
|
The remainder of this page focuses on the **in-tree** option which is
|
||||||
the recommended method of development for the majority of changes. See
|
the recommended method of development for the majority of changes. See
|
||||||
the [[custom-packages]] page for additional information on building
|
the :doc:`custom packages <./Custom Packages>` page for additional information on building
|
||||||
custom packages.
|
custom packages.
|
||||||
|
|
||||||
Developing In-Tree
|
Developing In-Tree
|
||||||
@@ -152,7 +155,7 @@ tradition autotools fashion.
|
|||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
make deb #example for Debian/Ubuntu
|
make deb #example for Debian/Ubuntu
|
||||||
|
|
||||||
Install
|
Install
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
@@ -1,3 +1,6 @@
|
|||||||
|
Custom Packages
|
||||||
|
===============
|
||||||
|
|
||||||
The following instructions assume you are building from an official
|
The following instructions assume you are building from an official
|
||||||
`release tarball <https://github.com/zfsonlinux/zfs/releases/latest>`__
|
`release tarball <https://github.com/zfsonlinux/zfs/releases/latest>`__
|
||||||
(version 0.8.0 or newer) or directly from the `git
|
(version 0.8.0 or newer) or directly from the `git
|
||||||
@@ -8,7 +8,7 @@ Recommended reading: `ZFS on Linux
|
|||||||
CONTRIBUTING.md <https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md>`__
|
CONTRIBUTING.md <https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md>`__
|
||||||
|
|
||||||
First time setup
|
First time setup
|
||||||
================
|
----------------
|
||||||
|
|
||||||
If you've never used Git before, you'll need a little setup to start
|
If you've never used Git before, you'll need a little setup to start
|
||||||
things off.
|
things off.
|
||||||
@@ -19,7 +19,7 @@ things off.
|
|||||||
git config --global user.email myemail@noreply.non
|
git config --global user.email myemail@noreply.non
|
||||||
|
|
||||||
Cloning the initial repository
|
Cloning the initial repository
|
||||||
==============================
|
------------------------------
|
||||||
|
|
||||||
The easiest way to get started is to click the fork icon at the top of
|
The easiest way to get started is to click the fork icon at the top of
|
||||||
the main repository page. From there you need to download a copy of the
|
the main repository page. From there you need to download a copy of the
|
||||||
@@ -40,7 +40,7 @@ upstream repository as another remote (man git-remote):
|
|||||||
git remote add upstream https://github.com/zfsonlinux/zfs.git
|
git remote add upstream https://github.com/zfsonlinux/zfs.git
|
||||||
|
|
||||||
Preparing and making changes
|
Preparing and making changes
|
||||||
============================
|
----------------------------
|
||||||
|
|
||||||
In order to make changes it is recommended to make a branch, this lets
|
In order to make changes it is recommended to make a branch, this lets
|
||||||
you work on several unrelated changes at once. It is also not
|
you work on several unrelated changes at once. It is also not
|
||||||
@@ -61,7 +61,7 @@ Resources <https://github.com/zfsonlinux/zfs/wiki/Developer-Resources>`__,
|
|||||||
Resources <http://open-zfs.org/wiki/Developer_resources>`__
|
Resources <http://open-zfs.org/wiki/Developer_resources>`__
|
||||||
|
|
||||||
Testing your patches before pushing
|
Testing your patches before pushing
|
||||||
===================================
|
-----------------------------------
|
||||||
|
|
||||||
Before committing and pushing, you may want to test your patches. There
|
Before committing and pushing, you may want to test your patches. There
|
||||||
are several tests you can run against your branch such as style
|
are several tests you can run against your branch such as style
|
||||||
@@ -85,7 +85,7 @@ Suite
|
|||||||
README <https://github.com/zfsonlinux/zfs/blob/master/tests/README.md>`__
|
README <https://github.com/zfsonlinux/zfs/blob/master/tests/README.md>`__
|
||||||
|
|
||||||
Committing your changes to be pushed
|
Committing your changes to be pushed
|
||||||
====================================
|
------------------------------------
|
||||||
|
|
||||||
When you are done making changes to your branch there are a few more
|
When you are done making changes to your branch there are a few more
|
||||||
steps before you can make a pull request.
|
steps before you can make a pull request.
|
||||||
@@ -144,7 +144,7 @@ request for an existing issue as shown above. Save and exit the editor
|
|||||||
when you are done.
|
when you are done.
|
||||||
|
|
||||||
Pushing and creating the pull request
|
Pushing and creating the pull request
|
||||||
=====================================
|
-------------------------------------
|
||||||
|
|
||||||
Home stretch. You've made your change and made the commit. Now it's time
|
Home stretch. You've made your change and made the commit. Now it's time
|
||||||
to push it.
|
to push it.
|
||||||
@@ -161,7 +161,7 @@ repository on GitHub and you should see a button for making a new pull
|
|||||||
request for your recently committed branch.
|
request for your recently committed branch.
|
||||||
|
|
||||||
Correcting issues with your pull request
|
Correcting issues with your pull request
|
||||||
========================================
|
----------------------------------------
|
||||||
|
|
||||||
Sometimes things don't always go as planned and you may need to update
|
Sometimes things don't always go as planned and you may need to update
|
||||||
your pull request with a correction to either your commit message, or
|
your pull request with a correction to either your commit message, or
|
||||||
@@ -180,7 +180,7 @@ any build/test servers currently running and excessively pushing can
|
|||||||
cause delays in processing of all pull requests.
|
cause delays in processing of all pull requests.
|
||||||
|
|
||||||
Maintaining your repository
|
Maintaining your repository
|
||||||
===========================
|
---------------------------
|
||||||
|
|
||||||
When you wish to make changes in the future you will want to have an
|
When you wish to make changes in the future you will want to have an
|
||||||
up-to-date copy of the upstream repository to make your changes on. Here
|
up-to-date copy of the upstream repository to make your changes on. Here
|
||||||
@@ -196,7 +196,7 @@ This will make sure you are on the master branch of the repository, grab
|
|||||||
the changes from upstream, then push them back to your repository.
|
the changes from upstream, then push them back to your repository.
|
||||||
|
|
||||||
Final words
|
Final words
|
||||||
===========
|
-----------
|
||||||
|
|
||||||
This is a very basic introduction to Git and GitHub, but should get you
|
This is a very basic introduction to Git and GitHub, but should get you
|
||||||
on your way to contributing to many open source projects. Not all
|
on your way to contributing to many open source projects. Not all
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
|
OpenZFS Exceptions
|
||||||
|
==================
|
||||||
|
|
||||||
Commit exceptions used to explicitly reference a given Linux commit.
|
Commit exceptions used to explicitly reference a given Linux commit.
|
||||||
These exceptions are useful for a variety of reasons.
|
These exceptions are useful for a variety of reasons.
|
||||||
|
|
||||||
**This page is used to generate**\ `OpenZFS
|
**This page is used to generate**
|
||||||
Tracking <http://build.zfsonlinux.org/openzfs-tracking.html>`__\ **page.**
|
`OpenZFS Tracking <http://build.zfsonlinux.org/openzfs-tracking.html>`__
|
||||||
|
**page.**
|
||||||
|
|
||||||
Format:
|
Format:
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
@@ -1,3 +1,6 @@
|
|||||||
|
OpenZFS Patches
|
||||||
|
===============
|
||||||
|
|
||||||
The ZFS on Linux project is an adaptation of the upstream `OpenZFS
|
The ZFS on Linux project is an adaptation of the upstream `OpenZFS
|
||||||
repository <https://github.com/openzfs/openzfs/>`__ designed to work in
|
repository <https://github.com/openzfs/openzfs/>`__ designed to work in
|
||||||
a Linux environment. This upstream repository acts as a location where
|
a Linux environment. This upstream repository acts as a location where
|
||||||
18
docs/Developer Resources/index.rst
Normal file
18
docs/Developer Resources/index.rst
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
Developer Resources
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Contents:
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
Custom Packages
|
||||||
|
Building ZFS
|
||||||
|
Buildbot Status <http://build.zfsonlinux.org/tgrid?length=100&branch=master&category=Platforms&rev_order=desc>
|
||||||
|
Buildbot Issue Tracking <http://build.zfsonlinux.org/known-issues.html>
|
||||||
|
Buildbot Options <https://github.com/zfsonlinux/zfs/wiki/Buildbot-Options>
|
||||||
|
OpenZFS Tracking <http://build.zfsonlinux.org/openzfs-tracking.html>
|
||||||
|
OpenZFS Patches
|
||||||
|
OpenZFS Exceptions
|
||||||
|
OpenZFS Documentation <http://open-zfs.org/wiki/Developer_resources>
|
||||||
|
Git and GitHub for beginners
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
Developer Resources
|
|
||||||
===================
|
|
||||||
|
|
||||||
| [[Custom Packages]]
|
|
||||||
| [[Building ZFS]]
|
|
||||||
| `Buildbot
|
|
||||||
Status <http://build.zfsonlinux.org/tgrid?length=100&branch=master&category=Tests&rev_order=desc>`__
|
|
||||||
| `Buildbot
|
|
||||||
Options <https://github.com/zfsonlinux/zfs/wiki/Buildbot-Options>`__
|
|
||||||
| `OpenZFS
|
|
||||||
Tracking <http://build.zfsonlinux.org/openzfs-tracking.html>`__
|
|
||||||
| [[OpenZFS Patches]]
|
|
||||||
| [[OpenZFS Exceptions]]
|
|
||||||
| `OpenZFS
|
|
||||||
Documentation <http://open-zfs.org/wiki/Developer_resources>`__
|
|
||||||
| [[Git and GitHub for beginners]]
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
This page is obsolete, use
|
|
||||||
`http://build.zfsonlinux.org/openzfs-tracking.html <http://build.zfsonlinux.org/openzfs-tracking.html>`__
|
|
||||||
Reference in New Issue
Block a user