diff --git a/docs/ci.rst b/docs/ci.rst index a651b3b9820142..6350ea899fa259 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -33,15 +33,24 @@ In these sections there are instructions to bring-up your own continuous integra either to run locally, in a self-hosted runner or even in a cluster. Beyond the linear history ``main`` branch, the following upstream mirrors are -provided (``mirror//``): +provided (``mirror_ci//``): -* | ``mirror/next/linux-next/master``: Patches aimed at the next kernel merge window +* | ``mirror_ci/next/linux-next/master``: Patches aimed at the next kernel merge window | https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/log/?h=master -* | ``mirror/jic23/iio/testing``: Linux IIO Subsystem (Cameron's branch) +* | ``mirror_ci/jic23/iio/testing``: Linux IIO Subsystem (Cameron's branch) | https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/log/?h=testing +* | ``mirror_ci/lee/mfd/for-mfd-next``: MFD Subsystem Tree - Next and Fixes + | https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git/log/?h=for-mfd-next When upstreaming a driver, target the pull-request against the mirror. +.. attention:: + + Do **not** base your work on the head of the ``mirror_ci/*``, it is + frequently force pushed either by upstream (they are testing branches after + all). Instead, find a common stable base, for example the previous tag such + as `v6.19-rc1 `__ + All of them are mirrors from the links shown with a single commit on top that includes the CI workflows, :git-linux:`as simple as `: diff --git a/docs/contribute.rst b/docs/contribute.rst index f9d6becba1828f..0955a22d90e423 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -175,6 +175,16 @@ conventions, and lifecycle, helping maintain modularity and clarity. For an up-to-date map of these subsystems and their interfaces, see :external+upstream:doc:`subsystem-apis`. +When developing for a particular subsystem, look for the appropriate git tree +in the :git-linux:`MAINTAINERS` file to work on. Development branches may be +force pushed. It is reasonable to base you work on top of the current latest +tag, such as `v6.19-rc1 +`__ +or near it, this avoids unnecessary merge commits when pulling changes. + +For some subsystems, CI/CD is automatically applied to developemnt branches as +described at :ref:`ci`. + IIO Subsytem ~~~~~~~~~~~~