mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-22 18:08:16 +00:00
Code Issues Releases Wiki Activity

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

Browse Source
This commit is contained in:
Andrei Pavel 2025-07-28 10:31:47 +03:00
parent fca00ed798
commit 4c81b194b9
No known key found for this signature in database
GPG Key ID: D4E804481939CB21
3 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/devel/bison.dox
View File

@ -46,7 +46,7 @@ https://gitlab.isc.org/isc-projects/kea/wikis/designs/simple-parser-design.
@section parserBisonIntro Flex/Bison Based Parser @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 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 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 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. convey the intent; a more detailed description is available in subsequent sections.
@ -115,12 +115,6 @@ meson setup build
meson compile -C build grammar meson compile -C build grammar
@endcode @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 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 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 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 @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 6. Run the unit-tests that you wrote before you touched any of the bison stuff. You did write them
in advance, right? in advance, right?

2
doc/sphinx/kea-messages.rst
View File

@ -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: .. _kea-messages:

2
doc/sphinx/mes2doc.py
View File

@ -82,7 +82,7 @@ def read_input_files(files):
def generate_rst(messages): def generate_rst(messages):
rst = '..\n' 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: rst += '''.. _kea-messages: