Razvan Becheriu
be9faa8f0d
[ #4014 ] addressed review comments
2025-07-30 16:44:26 +03:00
Thomas Markwalder
9ee137c846
[ #4014 ] Core and UT for v6 option class-tags
...
Changes to be committed:
modified: doc/sphinx/arm/hooks-cb-cmds.rst
modified: src/hooks/dhcp/mysql/mysql_cb_dhcp6.cc
modified: src/hooks/dhcp/mysql/mysql_cb_dhcp6.h
modified: src/hooks/dhcp/mysql/mysql_cb_impl.cc
modified: src/hooks/dhcp/mysql/tests/mysql_cb_dhcp6_unittest.cc
modified: src/hooks/dhcp/pgsql/pgsql_cb_dhcp6.cc
modified: src/hooks/dhcp/pgsql/pgsql_cb_dhcp6.h
modified: src/hooks/dhcp/pgsql/pgsql_cb_impl.cc
modified: src/hooks/dhcp/pgsql/tests/pgsql_cb_dhcp6_unittest.cc
modified: src/lib/dhcpsrv/config_backend_dhcp6.h
modified: src/lib/dhcpsrv/config_backend_pool_dhcp6.cc
modified: src/lib/dhcpsrv/config_backend_pool_dhcp6.h
modified: src/lib/dhcpsrv/testutils/generic_cb_dhcp4_unittest.h
modified: src/lib/dhcpsrv/testutils/generic_cb_dhcp6_unittest.cc
modified: src/lib/dhcpsrv/testutils/generic_cb_dhcp6_unittest.h
modified: src/lib/dhcpsrv/testutils/test_config_backend_dhcp4.cc
modified: src/lib/dhcpsrv/testutils/test_config_backend_dhcp4.h
modified: src/lib/dhcpsrv/testutils/test_config_backend_dhcp6.cc
modified: src/lib/dhcpsrv/testutils/test_config_backend_dhcp6.h
modified: src/share/api/remote-option4-global-del.json
modified: src/share/api/remote-option4-global-get.json
modified: src/share/api/remote-option4-global-set.json
modified: src/share/api/remote-option4-network-del.json
modified: src/share/api/remote-option4-network-set.json
modified: src/share/api/remote-option4-pool-del.json
modified: src/share/api/remote-option4-pool-set.json
modified: src/share/api/remote-option4-subnet-del.json
modified: src/share/api/remote-option4-subnet-set.json
modified: src/share/api/remote-option6-global-del.json
modified: src/share/api/remote-option6-global-get.json
modified: src/share/api/remote-option6-global-set.json
modified: src/share/api/remote-option6-network-del.json
modified: src/share/api/remote-option6-network-set.json
modified: src/share/api/remote-option6-pd-pool-del.json
modified: src/share/api/remote-option6-pd-pool-set.json
modified: src/share/api/remote-option6-pool-del.json
modified: src/share/api/remote-option6-pool-set.json
modified: src/share/api/remote-option6-subnet-del.json
2025-07-29 08:30:06 -04:00
Thomas Markwalder
67473622a6
[ #3770 ] Revert v6 doc change
...
modified: doc/sphinx/arm/hooks-cb-cmds.rst
2025-07-22 09:07:54 -04:00
Thomas Markwalder
d278d5205c
[ #3770 ] Updated ARM and api files
...
new file: changelog_unreleased/3770-examine-cb-command-behavior-for-mulitple-options-with-the-same-code-in-a-given-scope
modified: doc/sphinx/arm/hooks-cb-cmds.rst
modified: src/share/api/remote-option4-global-del.json
modified: src/share/api/remote-option4-global-get.json
modified: src/share/api/remote-option4-global-set.json
modified: src/share/api/remote-option4-network-del.json
modified: src/share/api/remote-option4-network-set.json
modified: src/share/api/remote-option4-pool-del.json
modified: src/share/api/remote-option4-pool-set.json
modified: src/share/api/remote-option4-subnet-del.json
modified: src/share/api/remote-option4-subnet-set.json
2025-07-21 15:36:55 -04:00
Razvan Becheriu
264b7100cb
[ #3586 ] updated documentation
2024-10-09 13:10:06 +00:00
Suzanne Goldlust
7730a1d60d
Resolve "Editorial review of the ARM prior to 2.6 release"
2024-05-16 20:09:54 +00:00
Andrei Pavel
2d6de9b3fb
[ #2442 ] enable nitpicky in sphinx
...
To warn about all broken references. Also fixes the few broken
references found.
2023-11-15 18:48:51 +02:00
Andrei Pavel
153ace53c1
[ #2554 ] add notes about each hook library's packaging
...
- Premium libraries were marked as subscription libraries.
That has also been fixed.
2023-06-14 20:26:11 +03:00
Andrei Pavel
7e1b388777
[ #2554 ] address review comments
2023-06-14 20:26:11 +03:00
Andrei Pavel
aaa3a91b9b
[ #2554 ] add 'ischooklib' anchors and references
2023-06-14 20:26:11 +03:00
Andrei Pavel
a51ab99885
[ #2554 ] add 'isccmd' references
...
The commands used were:
- find doc/sphinx/arm -name '*.rst' | xargs grep -E '^\.\. ' | cut -d ' ' -f 2 | sort -uV | grep _command- > /tmp/commands
- for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`\`${i}\`\` command/\`${i} command <_command-${i}>\`/g"; done
- for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`\`${i}\`\`/\`${i} <_command-${i}>\`/g"; done
- for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/The \`${i} <_command-${i}>\` Command/The \`\`${i}\`\` Command/g"; done
- for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/- ${i}/- \`${i} <_command-${i}>\`/g"; done
But they were not perfect. Some manual adjustment was required.
2023-06-14 20:26:11 +03:00
Andrei Pavel
f936be3222
[ #2554 ] add 'iscman' references
...
The commands used were:
- find doc/sphinx/man -name '*.rst' | xargs grep -F '.. iscman' | cut -d ' ' -f 3 > /tmp/binaries
- for i in $(cat /tmp/binaries); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`\`${i}\`\`/:iscman:\`${i}\`/g"; done
Manual adjustment was required in a few places to:
- extend title lines
- realign table lines
2023-06-14 20:26:11 +03:00
Andrei Pavel
bf8efb6502
[ #2554 ] add 'isccmd' anchors
2023-06-14 20:26:11 +03:00
Razvan Becheriu
c056162c99
[ #2827 ] reverted src/share/api and updated script
2023-05-11 11:31:16 +03:00
Razvan Becheriu
50abca6f3f
[ #2827 ] fixed all json examples in arm
2023-05-11 11:30:02 +03:00
Andrei Pavel
ab23887672
[ #2804 ] make text edits consistent across the ARM
2023-04-19 17:58:06 +03:00
Andrei Pavel
2b4ca27b3a
[ #2569 ] add JSON validation to code blocks in ARM
2022-09-23 12:09:23 +00:00
Suzanne Goldlust
8c36885105
[ #2403 ] Final changes to section header formatting
2022-06-14 14:12:09 -04:00
Suzanne Goldlust
fac7b69913
[ #2403 ] Testing one possible header style
2022-06-14 14:12:09 -04:00
Suzanne Goldlust
e53bab6c7b
[ #2403 ] Add text, reformat section header
2022-06-14 14:09:03 -04:00
Suzanne Goldlust
f71a698501
[ #2403 ] Editorial review of documentation about hook libraries in the ARM
2022-06-14 14:09:03 -04:00
Razvan Becheriu
ee964de4c2
[ #2322 ] addressed review comments
2022-02-28 18:01:56 +02:00
Thomas Markwalder
d5b7e8293a
[ #2322 ] Updated the ARM
...
doc/sphinx/arm/config-backend.rst
doc/sphinx/arm/dhcp4-srv.rst
2022-02-24 10:57:54 -05:00
Marcin Siodelski
4a380c004c
[ #2028 ] Updated the ARM
...
Added a note about specifying option data and option definitions when
using the configuration backend. This was requested in the review.
2021-09-22 14:07:28 +02:00
Marcin Siodelski
591cf75454
[ #1977 ] Addressed review comments
...
Added note that client classes from the database replace all classes
specified in the file. Added syntax highlighting to cb_cmds. Corrected
some typos.
2021-07-23 08:06:16 +02:00
Marcin Siodelski
8706c0c6f8
[ #1977 ] Described class commands
...
Described CB commands for manipulating client classes.
2021-07-23 08:04:51 +02:00
peterd
c0cabdd0b7
[ #1917 ] Final updates
2021-06-17 13:09:05 +00:00
peterd
d575f854cf
[ #1917 ] Changes up to and including Chapter 23
2021-06-17 13:09:05 +00:00
Suzanne Goldlust
76b25d1836
Fix typos, and other text corrections
...
Mostly minor text fixups, with a few edits for clarity
2020-11-20 11:32:22 +01:00
Marcin Siodelski
9e5bafd1cc
[#847,!23-p] Fixed example of the remote-option6-pd-pool-set command.
2019-08-20 18:20:55 +02:00
Tomek Mrugalski
f1ae84186b
[#810,!471] Changed title levels in hooks-*.rst files
...
- mostly --- to ~~~
2019-08-16 19:58:41 +02:00
Marcin Siodelski
26024b6739
[#826,!479] Removed empty section title.
2019-08-14 22:36:12 +02:00
Marcin Siodelski
bad7a4a73b
[#826,!479] Updated cb_cmds hooks doc describing the embedded option cmds.
2019-08-14 22:36:11 +02:00
Francis Dupont
f4705d6207
[826-documentation-of-cb_cmds-embedded-commands] Added API files
2019-08-14 22:36:11 +02:00
Tomek Mrugalski
978da1e664
[#644,!370] Manually applied changes xml => rst made on branch 643-update-kea-arm-with-description-of-the-commands-which-manage-the-server-in-the-database
2019-07-30 10:45:13 +02:00
Michal Nowikowski
519035a179
revamped api doc generation
2019-07-30 10:45:13 +02:00
Michal Nowikowski
01fb9fd370
rearranges docs and build script
...
Two reasons:
- sphinx requires to have all sources in its source directory
so man pages have to be moved
- layout of subfolders in doc folder was not consistent
2019-07-30 10:45:13 +02:00