From 6bdae907647691fe2f380efcd281cc276fafb3d0 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Tue, 11 Aug 2015 14:49:52 +0200 Subject: [PATCH] doc: rename guidelines for contributors Clarify target of guidelines by renaming the title and the directory. Signed-off-by: Thomas Monjalon Acked-by: John McNamara --- doc/guides/{guidelines => contributing}/coding_style.rst | 0 doc/guides/{guidelines => contributing}/design.rst | 0 doc/guides/{guidelines => contributing}/documentation.rst | 2 +- doc/guides/{guidelines => contributing}/index.rst | 5 ++--- doc/guides/{guidelines => contributing}/versioning.rst | 0 doc/guides/index.rst | 2 +- doc/guides/rel_notes/deprecation.rst | 2 +- 7 files changed, 5 insertions(+), 6 deletions(-) rename doc/guides/{guidelines => contributing}/coding_style.rst (100%) rename doc/guides/{guidelines => contributing}/design.rst (100%) rename doc/guides/{guidelines => contributing}/documentation.rst (99%) rename doc/guides/{guidelines => contributing}/index.rst (68%) rename doc/guides/{guidelines => contributing}/versioning.rst (100%) diff --git a/doc/guides/guidelines/coding_style.rst b/doc/guides/contributing/coding_style.rst similarity index 100% rename from doc/guides/guidelines/coding_style.rst rename to doc/guides/contributing/coding_style.rst diff --git a/doc/guides/guidelines/design.rst b/doc/guides/contributing/design.rst similarity index 100% rename from doc/guides/guidelines/design.rst rename to doc/guides/contributing/design.rst diff --git a/doc/guides/guidelines/documentation.rst b/doc/guides/contributing/documentation.rst similarity index 99% rename from doc/guides/guidelines/documentation.rst rename to doc/guides/contributing/documentation.rst index 06eb0c9626..cb5ca0dc7b 100644 --- a/doc/guides/guidelines/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -65,7 +65,7 @@ added to by the developer. Developers should update the Release Notes to add a short description of new or updated features. Developers should also update the Release Notes to add ABI announcements if necessary, - (see :doc:`/guidelines/versioning` for details). + (see :doc:`/contributing/versioning` for details). * **API documentation** diff --git a/doc/guides/guidelines/index.rst b/doc/guides/contributing/index.rst similarity index 68% rename from doc/guides/guidelines/index.rst rename to doc/guides/contributing/index.rst index 1050d99255..561427b37b 100644 --- a/doc/guides/guidelines/index.rst +++ b/doc/guides/contributing/index.rst @@ -1,5 +1,5 @@ -Guidelines -========== +Contributor's Guidelines +======================== .. toctree:: :maxdepth: 2 @@ -9,4 +9,3 @@ Guidelines design versioning documentation - diff --git a/doc/guides/guidelines/versioning.rst b/doc/guides/contributing/versioning.rst similarity index 100% rename from doc/guides/guidelines/versioning.rst rename to doc/guides/contributing/versioning.rst diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 0a89efd412..f92dfc8912 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -45,4 +45,4 @@ Contents: sample_app_ug/index testpmd_app_ug/index rel_notes/index - guidelines/index + contributing/index diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 5330d3b3d3..b45ac4cfe0 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -1,7 +1,7 @@ Deprecation =========== -See the :doc:`guidelines document for details of the ABI policy `. +See the :doc:`guidelines document for details of the ABI policy `. API and ABI deprecation notices are to be posted here. Help to update from a previous release is provided in -- 2.20.1