From 8ce59fb624135d014a60bb46c0078c9a1e9a4d4b Mon Sep 17 00:00:00 2001 From: George Melikov Date: Sat, 16 May 2020 20:50:01 +0300 Subject: [PATCH] Adopt Developer Resources section Signed-off-by: George Melikov --- .../Buildbot-Options.rst | 0 .../Building ZFS.rst} | 7 +++++-- .../Custom Packages.rst} | 3 +++ .../Git and GitHub for beginners.rst} | 18 +++++++++--------- .../OpenZFS Exceptions.rst} | 8 ++++++-- .../OpenZFS Patches.rst} | 3 +++ docs/Developer Resources/index.rst | 18 ++++++++++++++++++ docs/Developer-Resources.rst | 16 ---------------- docs/OpenZFS-Tracking.rst | 2 -- 9 files changed, 44 insertions(+), 31 deletions(-) rename docs/{ => Developer Resources}/Buildbot-Options.rst (100%) rename docs/{Building-ZFS.rst => Developer Resources/Building ZFS.rst} (98%) rename docs/{Custom-Packages.rst => Developer Resources/Custom Packages.rst} (99%) rename docs/{Git-and-GitHub-for-beginners.rst => Developer Resources/Git and GitHub for beginners.rst} (95%) rename docs/{OpenZFS-exceptions.rst => Developer Resources/OpenZFS Exceptions.rst} (99%) rename docs/{OpenZFS-Patches.rst => Developer Resources/OpenZFS Patches.rst} (99%) create mode 100644 docs/Developer Resources/index.rst delete mode 100644 docs/Developer-Resources.rst delete mode 100644 docs/OpenZFS-Tracking.rst diff --git a/docs/Buildbot-Options.rst b/docs/Developer Resources/Buildbot-Options.rst similarity index 100% rename from docs/Buildbot-Options.rst rename to docs/Developer Resources/Buildbot-Options.rst diff --git a/docs/Building-ZFS.rst b/docs/Developer Resources/Building ZFS.rst similarity index 98% rename from docs/Building-ZFS.rst rename to docs/Developer Resources/Building ZFS.rst index 1fae4d6..2bf7ea6 100644 --- a/docs/Building-ZFS.rst +++ b/docs/Developer Resources/Building ZFS.rst @@ -1,3 +1,6 @@ +Building ZFS +============ + GitHub Repositories ~~~~~~~~~~~~~~~~~~~ @@ -72,7 +75,7 @@ depends on your requirements. 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 [[custom-packages]] page for additional information on building +the :doc:`custom packages <./Custom Packages>` page for additional information on building custom packages. Developing In-Tree @@ -152,7 +155,7 @@ tradition autotools fashion. :: - make deb #example for Debian/Ubuntu + make deb #example for Debian/Ubuntu Install ^^^^^^^ diff --git a/docs/Custom-Packages.rst b/docs/Developer Resources/Custom Packages.rst similarity index 99% rename from docs/Custom-Packages.rst rename to docs/Developer Resources/Custom Packages.rst index 3f0efbf..3a21a8b 100644 --- a/docs/Custom-Packages.rst +++ b/docs/Developer Resources/Custom Packages.rst @@ -1,3 +1,6 @@ +Custom Packages +=============== + The following instructions assume you are building from an official `release tarball `__ (version 0.8.0 or newer) or directly from the `git diff --git a/docs/Git-and-GitHub-for-beginners.rst b/docs/Developer Resources/Git and GitHub for beginners.rst similarity index 95% rename from docs/Git-and-GitHub-for-beginners.rst rename to docs/Developer Resources/Git and GitHub for beginners.rst index a553be5..c99ee11 100644 --- a/docs/Git-and-GitHub-for-beginners.rst +++ b/docs/Developer Resources/Git and GitHub for beginners.rst @@ -8,7 +8,7 @@ Recommended reading: `ZFS on Linux CONTRIBUTING.md `__ First time setup -================ +---------------- If you've never used Git before, you'll need a little setup to start things off. @@ -19,7 +19,7 @@ things off. git config --global user.email myemail@noreply.non Cloning the initial repository -============================== +------------------------------ 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 @@ -40,7 +40,7 @@ upstream repository as another remote (man git-remote): git remote add upstream https://github.com/zfsonlinux/zfs.git Preparing and making changes -============================ +---------------------------- 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 @@ -61,7 +61,7 @@ Resources `__, Resources `__ Testing your patches before pushing -=================================== +----------------------------------- Before committing and pushing, you may want to test your patches. There are several tests you can run against your branch such as style @@ -85,7 +85,7 @@ Suite README `__ Committing your changes to be pushed -==================================== +------------------------------------ When you are done making changes to your branch there are a few more 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. Pushing and creating the pull request -===================================== +------------------------------------- Home stretch. You've made your change and made the commit. Now it's time 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. Correcting issues with your pull request -======================================== +---------------------------------------- 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 @@ -180,7 +180,7 @@ any build/test servers currently running and excessively pushing can cause delays in processing of all pull requests. Maintaining your repository -=========================== +--------------------------- 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 @@ -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. Final words -=========== +----------- 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 diff --git a/docs/OpenZFS-exceptions.rst b/docs/Developer Resources/OpenZFS Exceptions.rst similarity index 99% rename from docs/OpenZFS-exceptions.rst rename to docs/Developer Resources/OpenZFS Exceptions.rst index 6f74066..a0e4927 100644 --- a/docs/OpenZFS-exceptions.rst +++ b/docs/Developer Resources/OpenZFS Exceptions.rst @@ -1,8 +1,12 @@ +OpenZFS Exceptions +================== + Commit exceptions used to explicitly reference a given Linux commit. These exceptions are useful for a variety of reasons. -**This page is used to generate**\ `OpenZFS -Tracking `__\ **page.** +**This page is used to generate** +`OpenZFS Tracking `__ +**page.** Format: ^^^^^^^ diff --git a/docs/OpenZFS-Patches.rst b/docs/Developer Resources/OpenZFS Patches.rst similarity index 99% rename from docs/OpenZFS-Patches.rst rename to docs/Developer Resources/OpenZFS Patches.rst index 4b50ee6..fa622bd 100644 --- a/docs/OpenZFS-Patches.rst +++ b/docs/Developer Resources/OpenZFS Patches.rst @@ -1,3 +1,6 @@ +OpenZFS Patches +=============== + The ZFS on Linux project is an adaptation of the upstream `OpenZFS repository `__ designed to work in a Linux environment. This upstream repository acts as a location where diff --git a/docs/Developer Resources/index.rst b/docs/Developer Resources/index.rst new file mode 100644 index 0000000..4b591ff --- /dev/null +++ b/docs/Developer Resources/index.rst @@ -0,0 +1,18 @@ +Developer Resources +=================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + Custom Packages + Building ZFS + Buildbot Status + Buildbot Issue Tracking + Buildbot Options + OpenZFS Tracking + OpenZFS Patches + OpenZFS Exceptions + OpenZFS Documentation + Git and GitHub for beginners diff --git a/docs/Developer-Resources.rst b/docs/Developer-Resources.rst deleted file mode 100644 index e786d1e..0000000 --- a/docs/Developer-Resources.rst +++ /dev/null @@ -1,16 +0,0 @@ -Developer Resources -=================== - -| [[Custom Packages]] -| [[Building ZFS]] -| `Buildbot - Status `__ -| `Buildbot - Options `__ -| `OpenZFS - Tracking `__ -| [[OpenZFS Patches]] -| [[OpenZFS Exceptions]] -| `OpenZFS - Documentation `__ -| [[Git and GitHub for beginners]] diff --git a/docs/OpenZFS-Tracking.rst b/docs/OpenZFS-Tracking.rst deleted file mode 100644 index 6d7cf37..0000000 --- a/docs/OpenZFS-Tracking.rst +++ /dev/null @@ -1,2 +0,0 @@ -This page is obsolete, use -`http://build.zfsonlinux.org/openzfs-tracking.html `__