From: Andrei Pavel <andrei@isc.org>
Date: Mon, 28 Jul 2025 07:31:47 +0000 (+0300)
Subject: [#4031] Convert some leftover docs from autotools to meson
X-Git-Tag: Kea-3.1.0
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=4c81b194b94e2e1ed9579f14a2a3ec92a0ffab93;p=thirdparty%2Fkea.git

[#4031] Convert some leftover docs from autotools to meson
---

diff --git a/doc/devel/bison.dox b/doc/devel/bison.dox
index 5224e3e427..d6430930d0 100644
--- a/doc/devel/bison.dox
+++ b/doc/devel/bison.dox
@@ -46,7 +46,7 @@ https://gitlab.isc.org/isc-projects/kea/wikis/designs/simple-parser-design.
 @section parserBisonIntro Flex/Bison Based Parser
 
 To solve the issue of phase 1 mentioned earlier, a new parser has been developed that is based on
-the "flex and "bison" tools. The following text uses DHCPv6 as an example, but the same principle
+the flex and bison tools. The following text uses DHCPv6 as an example, but the same principle
 applies to DHCPv4 and D2; CA will likely to follow. The new parser consists of two core elements
 with a wrapper around them.  The following descriptions are slightly oversimplified in order to
 convey the intent; a more detailed description is available in subsequent sections.
@@ -115,12 +115,6 @@ meson setup build
 meson compile -C build grammar
 @endcode
 
-Strictly speaking, the comment "make parser" is not necessary. If you updated the .ll or .yy file,
-the regular "make" command should pick those changes up. However, since one source file generates
-multiple output files and you are likely to be using a multi-process build (by specifying the "-j"
-switch on the "make" command), there may be odd side effects: explicitly rebuilding the files
-manually by using "make parser" avoids any trouble.
-
 One problem brought on by use of flex/bison is tool version dependency. If one developer uses
 version A of those tools and another developer uses B, the files generated by the different version
 may be significantly different. This causes all sorts of problems, e.g.  coverity/cpp-check issues
@@ -450,7 +444,7 @@ Here's the complete set of changes that were necessary.
                 ;
    @endcode
 
-5. Regenerate the flex/bison files by typing "make parser".
+5. Regenerate the flex/bison files by typing "meson compile parser".
 
 6. Run the unit-tests that you wrote before you touched any of the bison stuff. You did write them
    in advance, right?
diff --git a/doc/sphinx/kea-messages.rst b/doc/sphinx/kea-messages.rst
index 29d2cebf43..1d8c3ffaa3 100644
--- a/doc/sphinx/kea-messages.rst
+++ b/doc/sphinx/kea-messages.rst
@@ -1,5 +1,5 @@
 ..
-    File generated by "doc/sphinx/mes2doc.py" or by "make -C doc/sphinx". Do not edit by hand.
+    File generated by "doc/sphinx/mes2doc.py" or by "meson compile mes-doc". Do not edit by hand.
 
 .. _kea-messages:
 
diff --git a/doc/sphinx/mes2doc.py b/doc/sphinx/mes2doc.py
index e4eaf962d1..bbd71ef957 100755
--- a/doc/sphinx/mes2doc.py
+++ b/doc/sphinx/mes2doc.py
@@ -82,7 +82,7 @@ def read_input_files(files):
 
 def generate_rst(messages):
     rst = '..\n'
-    rst += '    File generated by "doc/sphinx/mes2doc.py" or by "make -C doc/sphinx". Do not edit by hand.\n\n'
+    rst += '    File generated by "doc/sphinx/mes2doc.py" or by "meson compile mes-doc". Do not edit by hand.\n\n'
 
     rst += '''.. _kea-messages: