[3/3] Documentation: contributing: Update Source references
diff mbox series

Message ID 20251124165631.3040364-4-kieran.bingham@ideasonboard.com
State New
Headers show
Series
  • Documentation: Update contribution notes
Related show

Commit Message

Kieran Bingham Nov. 24, 2025, 4:56 p.m. UTC
The libcamera project is no longer in 'early' stages of development, and
we do make releases.

Update the Source Code section to reflect this reality and report on the
current expectations of release numbering schemes.

Furthermore update the development mirror as hosted on Freedesktop and
deprecate the LinuxTV mirror, as Freedesktop also hosts our release tar
balls and CI infrastructure.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/contributing.rst | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

Comments

Umang Jain Nov. 25, 2025, 5:31 a.m. UTC | #1
On 2025-11-24 22:26, Kieran Bingham wrote:
> The libcamera project is no longer in 'early' stages of development, and
> we do make releases.
> 
> Update the Source Code section to reflect this reality and report on the
> current expectations of release numbering schemes.
> 
> Furthermore update the development mirror as hosted on Freedesktop and
> deprecate the LinuxTV mirror, as Freedesktop also hosts our release tar
> balls and CI infrastructure.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Umang Jain <uajain@igalia.com>
> ---
>  Documentation/contributing.rst | 29 ++++++++++++++++++++++++++---
>  1 file changed, 26 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> index fbe34a0184e6..495bfb3196b3 100644
> --- a/Documentation/contributing.rst
> +++ b/Documentation/contributing.rst
> @@ -38,7 +38,26 @@ room:
>  Source Code
>  -----------
>  
> -libcamera is in early stages of development, and no releases are available yet.
> +libcamera is in active development, including investigations into what a 'good'
> +API is for the implementation. We can't guarantee we have all features
> +implemented, or designed correctly yet, and we have plans to make considerable
> +changes to the API and ABI in our roadmap.
> +
> +Even so, we provide periodic 'releases' to support distributions and packaging
> +teams. To support this we are currently making releases of the 0.y.z version
> +scheme, loosely following semver.
> +
> +In the foreseeable future, the following applies:
> +
> +  0.y.z : Active development, but with ABI breakage detection. The 0.y
> +          version will bump on an ABI/API breakage. Ongoing development will
> +          increment the .z version component. Therefore, pre 1.0 'y' is a
> +          close equivalent to a major release.
> +
> +  1.y.z : Stable API and ABI guarantees on the Major version number.
> +          Following semantic versioning as documented at https://semver.org/
> +
> +
>  The source code is available from the project's `git tree`_.
>  
>  .. code-block:: shell
> @@ -47,9 +66,13 @@ The source code is available from the project's `git tree`_.
>  
>  .. _git tree: https://git.libcamera.org/libcamera/libcamera.git/
>  
> -A mirror is also hosted on `LinuxTV`_.
> +A development mirror is also hosted on `Freedesktop`_.
>  
> -.. _LinuxTV: https://git.linuxtv.org/libcamera.git/
> +.. _Freedesktop: https://gitlab.freedesktop.org/camera/libcamera
> +
> +Freedesktop also provides our CI and `testing pipeline`_.
> +
> +.. _testing pipeline: https://gitlab.freedesktop.org/camera/libcamera/-/pipelines
>  
>  Issue Tracker
>  -------------

Patch
diff mbox series

diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
index fbe34a0184e6..495bfb3196b3 100644
--- a/Documentation/contributing.rst
+++ b/Documentation/contributing.rst
@@ -38,7 +38,26 @@  room:
 Source Code
 -----------
 
-libcamera is in early stages of development, and no releases are available yet.
+libcamera is in active development, including investigations into what a 'good'
+API is for the implementation. We can't guarantee we have all features
+implemented, or designed correctly yet, and we have plans to make considerable
+changes to the API and ABI in our roadmap.
+
+Even so, we provide periodic 'releases' to support distributions and packaging
+teams. To support this we are currently making releases of the 0.y.z version
+scheme, loosely following semver.
+
+In the foreseeable future, the following applies:
+
+  0.y.z : Active development, but with ABI breakage detection. The 0.y
+          version will bump on an ABI/API breakage. Ongoing development will
+          increment the .z version component. Therefore, pre 1.0 'y' is a
+          close equivalent to a major release.
+
+  1.y.z : Stable API and ABI guarantees on the Major version number.
+          Following semantic versioning as documented at https://semver.org/
+
+
 The source code is available from the project's `git tree`_.
 
 .. code-block:: shell
@@ -47,9 +66,13 @@  The source code is available from the project's `git tree`_.
 
 .. _git tree: https://git.libcamera.org/libcamera/libcamera.git/
 
-A mirror is also hosted on `LinuxTV`_.
+A development mirror is also hosted on `Freedesktop`_.
 
-.. _LinuxTV: https://git.linuxtv.org/libcamera.git/
+.. _Freedesktop: https://gitlab.freedesktop.org/camera/libcamera
+
+Freedesktop also provides our CI and `testing pipeline`_.
+
+.. _testing pipeline: https://gitlab.freedesktop.org/camera/libcamera/-/pipelines
 
 Issue Tracker
 -------------