minor: de-emphasize Gerrit in development/ docs
For ~everyone reading these docs, they should send KUnit patches directly to
upstream.
Move out all the stuff about Gerrit and CLAs to its own page so as not
to confuse these readers.
The only KUnit use of Gerrit right now is:
* for this website itself
* for the prow presubmit
* very rarely: as a staging ground for bigger changes
* e.g. the parser rewrite and QEMU support
* but we don't actually update the kunit gerrit repo often, so you
have to either work on an old base or pester someone to update it.
Change-Id: I2c29aef82f7cfc80407f4c58d295009e99742d68
Signed-off-by: Daniel Latypov <dlatypov@google.com>
diff --git a/development/gerrit-workflow.rst b/development/gerrit-workflow.rst
index 8ac71a9..b63a063 100644
--- a/development/gerrit-workflow.rst
+++ b/development/gerrit-workflow.rst
@@ -8,9 +8,8 @@
With that said, KUnit, as a project, is made up of several repositories. As
mentioned elsewhere, the actual KUnit unit testing code is in the upstream
-Linux kernel or is otherwise staged on Gerrit waiting to get into the Linux
-kernel. All our other code is in Gerrit. For an introduction to Gerrit (with a
-high level overview of git), see
+Linux kernel. All our other code is in Gerrit. For an introduction to Gerrit
+(with a high level overview of git), see
https://gerrit-review.googlesource.com/Documentation/intro-user.html. For
detailed introduction to git, see https://try.github.io.
diff --git a/development/index.rst b/development/index.rst
index be63c76..b8eb3bc 100644
--- a/development/index.rst
+++ b/development/index.rst
@@ -7,10 +7,11 @@
:caption: Contents:
start
- gerrit-workflow
design
useful-commands
prow
+ start_internal
+ gerrit-workflow
This set of pages provides information for developing KUnit itself. These pages
are for you if you plan on making submissions to KUnit, you are using KUnit for
@@ -20,8 +21,6 @@
Checkout:
- :doc:`start` for getting developing for KUnit.
-- :doc:`gerrit-workflow` to see how you might structure your workflow to work
- with git and Gerrit.
- :doc:`design` to learn about how KUnit is organized and how it got here.
- :doc:`useful-commands` for a collection of tips and tricks while working on
KUnit.
diff --git a/development/start.rst b/development/start.rst
index a2c1aec..7807edb 100644
--- a/development/start.rst
+++ b/development/start.rst
@@ -27,54 +27,7 @@
This section is for contributing code to repos that live outside of
https://git.kernel.org.
-Why is there a distinction?
----------------------------
+This only applies to the deprecated ``kunit/alpha/master`` branch and the other
+repos (like the one that hosts this site!).
-The Linux kernel has been around a lot longer than KUnit, and thus has rules
-that we have no say on. However, any code that lives outside of the kernel is
-managed by Google; it's open source and everyone has equal right to it, but
-because it is under the Google umbrella and not the Linux Foundation's umbrella
-it means that there are certain rules we have to follow in one place, and
-different rules in the other.
-
-The details are not important, all you have to know is that if you send code to
-the Linux kernel you should follow the rules above, and if you are contributing
-to any other KUnit repos, you should follow the rules here.
-
-If you still have confusion, feel free to reach out to us.
-
-Sign the Contributor License Agreement
---------------------------------------
-
-For any contributions not sent directly to the Linux kernel via the Linux
-kernel mailing lists, we require contributors to sign our Contributor License
-Agreement (CLA).
-
-You may sign our CLA here: https://cla.developers.google.com/
-
-.. note::
- Your company may already have a CLA on file with Google.
-
-Submitting Changes
-------------------
-
-We use `Gerrit <https://kunit-review.googlesource.com>`_ for all non-upstream
-code reviews.
-
-In order for Gerrit to accept your change, you must first make sure your commit
-messages are formatted correctly. It should have a:
-
-- ``Change-Id`` - see
- https://gerrit-review.googlesource.com/Documentation/user-changeid.html for
- more information.
-- ``Signed-off-by`` - see
- https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
-
-Now you are ready to send your change for review:
-
-.. code-block:: bash
-
- git push -u origin HEAD:refs/for/master
-
-For more information on submitting changes through Gerrit, please see the
-following section :doc:`gerrit-workflow`.
+See :doc:`start_internal` for more details.
diff --git a/development/start_internal.rst b/development/start_internal.rst
new file mode 100644
index 0000000..8c8569b
--- /dev/null
+++ b/development/start_internal.rst
@@ -0,0 +1,61 @@
+======================================================
+Getting Started Contributing to non-kernel KUnit repos
+======================================================
+
+This page is for contributing code to repos that live outside of
+https://git.kernel.org.
+
+You most likely want to contribute to KUnit in upstream Linux directly, see
+:doc:`start`.
+
+Why is there a difference?
+--------------------------
+
+The Linux kernel has been around a lot longer than KUnit, and thus has rules
+that we have no say on. However, any code that lives outside of the kernel is
+managed by Google; it's open source and everyone has equal right to it, but
+because it is under the Google umbrella and not the Linux Foundation's umbrella
+it means that there are certain rules we have to follow in one place, and
+different rules in the other.
+
+The details are not important, all you have to know is that if you send code to
+the Linux kernel you should follow the rules above, and if you are contributing
+to any other KUnit repos, you should follow the rules here.
+
+If you still have confusion, feel free to reach out to us.
+
+Sign the Contributor License Agreement
+--------------------------------------
+
+For any contributions not sent directly to the Linux kernel via the Linux
+kernel mailing lists, we require contributors to sign our Contributor License
+Agreement (CLA).
+
+You may sign our CLA here: https://cla.developers.google.com/
+
+.. note::
+ Your company may already have a CLA on file with Google.
+
+Submitting Changes
+------------------
+
+We use `Gerrit <https://kunit-review.googlesource.com>`_ for all non-upstream
+code reviews.
+
+In order for Gerrit to accept your change, you must first make sure your commit
+messages are formatted correctly. It should have a:
+
+- ``Change-Id`` - see
+ https://gerrit-review.googlesource.com/Documentation/user-changeid.html for
+ more information.
+- ``Signed-off-by`` - see
+ https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+
+Now you are ready to send your change for review:
+
+.. code-block:: bash
+
+ git push -u origin HEAD:refs/for/master
+
+For more information on submitting changes through Gerrit, please see the
+following section :doc:`gerrit-workflow`.