doc/manual: Drop LaTeX style guide

LaTeX is not used for the documentation but only as (intermediate)
output format. Developers do not need to write any LaTeX code at all and
will not need to do so in the future, so we do not need a style guide.

Remove the section on LaTeX from the style guide to make it clearer and
avoid confusion.

Change-Id: I238a35445616f39e38104ad0ff50ab246dd5990f
Signed-off-by: Marc Schink <dev@zapb.de>
Reviewed-on: https://review.openocd.org/c/openocd/+/9110
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>

diff --git a/doc/manual/primer/docs.txt b/doc/manual/primer/docs.txt
index 1aefa17e6dfe422780895099043de16dac813396..ccf4550d513ba70772152afd573ebdc9d6d8f891 100644 (file)
--- a/doc/manual/primer/docs.txt
+++ b/doc/manual/primer/docs.txt
@@ -16,7 +16,6 @@ OpenOCD presently produces several kinds of documentation:
   - Provides overview, usage, reference, and FAQ for each device.
   - Written using LaTeX language with custom macros.
   - Created with 'make references'.
-  - See @subpage primerlatex and @ref stylelatex.
 - The Manual:
   - Focuses on developing the OpenOCD software.
   - Details the architecture, driver interfaces, and processes.
@@ -44,19 +43,6 @@ the Texinfo web site for the Texinfo manual and more information.
 OpenOCD style guidelines for Texinfo documentation can be found on the
 @ref styletexinfo page.
 
- */
-/** @page primerlatex LaTeX Primer
-
-The OpenOCD project provides a number of reference guides using the
-LaTeX typesetting language.
-
-- OpenOCD Quick Reference Sheets
-- OpenOCD Hardware Reference Guides
-
-These documents have not yet been produced, so this Primer serves as
-a placeholder to describe how they are created and can be extended.
-The same holds true for the @ref stylelatex page.
-
  */
 /** @page primerdoxygen Doxygen Primer
 
@@ -118,7 +104,6 @@ This file contains the Doxygen source code for the @ref primerdocs.
 The @ref primerdocs page also contains the following sections:
 
 - @ref primertexinfo
-- @ref primerlatex
 - @ref primerdoxygen
 
  */

diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index f7a12988fc6b837a75506a622dfa84788397841c..fa08f4de9672da42251278ed19107cd2c14caddb 100644 (file)
--- a/doc/manual/style.txt
+++ b/doc/manual/style.txt
@@ -22,7 +22,6 @@ providing documentation, either as part of the C code or stand-alone.
 
 - @subpage styledoxygen
 - @subpage styletexinfo
-- @subpage stylelatex
 
 Feedback would be welcome to improve the OpenOCD guidelines.
 
@@ -449,13 +448,6 @@ be as productive as possible.  Needing to look at OpenOCD source code,
 to figure out how to use it is a bad sign, though it's OK to need to
 look at the User's guide to figure out what a config script is doing.
 
- */
-/** @page stylelatex LaTeX Style Guide
-
-This page needs to provide style guidelines for using LaTeX, the
-typesetting language used by The References for OpenOCD Hardware.
-Likewise, the @ref primerlatex for using this guide needs to be completed.
-
  */
 /** @page styleperl Perl Style Guide
 
@@ -510,7 +502,6 @@ documentation languages:
 - @ref stylec
 - @ref styledoxygen
 - @ref styletexinfo
-- @ref stylelatex
 - @ref styleperl
 - @ref styleautotools