Skip to content

Commit 4c81b19

Browse files
committed
[#4031] Convert some leftover docs from autotools to meson
1 parent fca00ed commit 4c81b19

File tree

3 files changed

+4
-10
lines changed

3 files changed

+4
-10
lines changed

doc/devel/bison.dox

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ https://gitlab.isc.org/isc-projects/kea/wikis/designs/simple-parser-design.
4646
@section parserBisonIntro Flex/Bison Based Parser
4747

4848
To solve the issue of phase 1 mentioned earlier, a new parser has been developed that is based on
49-
the "flex and "bison" tools. The following text uses DHCPv6 as an example, but the same principle
49+
the flex and bison tools. The following text uses DHCPv6 as an example, but the same principle
5050
applies to DHCPv4 and D2; CA will likely to follow. The new parser consists of two core elements
5151
with a wrapper around them. The following descriptions are slightly oversimplified in order to
5252
convey the intent; a more detailed description is available in subsequent sections.
@@ -115,12 +115,6 @@ meson setup build
115115
meson compile -C build grammar
116116
@endcode
117117

118-
Strictly speaking, the comment "make parser" is not necessary. If you updated the .ll or .yy file,
119-
the regular "make" command should pick those changes up. However, since one source file generates
120-
multiple output files and you are likely to be using a multi-process build (by specifying the "-j"
121-
switch on the "make" command), there may be odd side effects: explicitly rebuilding the files
122-
manually by using "make parser" avoids any trouble.
123-
124118
One problem brought on by use of flex/bison is tool version dependency. If one developer uses
125119
version A of those tools and another developer uses B, the files generated by the different version
126120
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.
450444
;
451445
@endcode
452446

453-
5. Regenerate the flex/bison files by typing "make parser".
447+
5. Regenerate the flex/bison files by typing "meson compile parser".
454448

455449
6. Run the unit-tests that you wrote before you touched any of the bison stuff. You did write them
456450
in advance, right?

doc/sphinx/kea-messages.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
File generated by "doc/sphinx/mes2doc.py" or by "make -C doc/sphinx". Do not edit by hand.
2+
File generated by "doc/sphinx/mes2doc.py" or by "meson compile mes-doc". Do not edit by hand.
33

44
.. _kea-messages:
55

doc/sphinx/mes2doc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def read_input_files(files):
8282

8383
def generate_rst(messages):
8484
rst = '..\n'
85-
rst += ' File generated by "doc/sphinx/mes2doc.py" or by "make -C doc/sphinx". Do not edit by hand.\n\n'
85+
rst += ' File generated by "doc/sphinx/mes2doc.py" or by "meson compile mes-doc". Do not edit by hand.\n\n'
8686

8787
rst += '''.. _kea-messages:
8888

0 commit comments

Comments
 (0)