diff mbox series

documentation: add comment to releases.rst switchers.js

Message ID 20211213164442.55720-1-michael.opdenacker@bootlin.com
State New
Headers show
Series documentation: add comment to releases.rst switchers.js | expand

Commit Message

Michael Opdenacker Dec. 13, 2021, 4:44 p.m. UTC 
To let release developers know that they don't need
to update these files in release branches other than "master".

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/releases.rst               | 7 +++++++
 documentation/sphinx-static/switchers.js | 8 ++++++++
 2 files changed, 15 insertions(+)
diff mbox series

Patch

diff --git a/documentation/releases.rst b/documentation/releases.rst
index e1d8eae8ef..83b9e76a62 100644
--- a/documentation/releases.rst
+++ b/documentation/releases.rst
@@ -1,5 +1,12 @@ 
 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
 
+..
+   NOTE FOR RELEASE MAINTAINERS:
+   This file only needs updating in the development release ("master" branch)
+   When documentation for stable releases is built,
+   the latest version from "master" is used
+   by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-build
+
 ===========================
  Supported Release Manuals
 ===========================
diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
index 056a8926ba..29bf02fe02 100644
--- a/documentation/sphinx-static/switchers.js
+++ b/documentation/sphinx-static/switchers.js
@@ -1,3 +1,11 @@ 
+/*
+NOTE FOR RELEASE MAINTAINERS:
+This file only needs updating in the development release ("master" branch)
+When documentation for stable releases is built,
+the latest version from "master" is used
+by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-build
+*/
+
 (function() {
   'use strict';