summaryrefslogtreecommitdiff
path: root/docs/contributing/development.rst
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-02-04 09:41:16 +0100
committerChristian Breunig <christian@breunig.cc>2023-02-04 09:41:16 +0100
commitd39ce49e2f54b99433c5c661fc1cb6efbbe6c930 (patch)
tree70072db192c6d6c78d3ff4ff1c8a8a117fcc05ed /docs/contributing/development.rst
parente84e0bf11cbe9336947605563a8f0d37586a05e8 (diff)
downloadvyos-documentation-d39ce49e2f54b99433c5c661fc1cb6efbbe6c930.tar.gz
vyos-documentation-d39ce49e2f54b99433c5c661fc1cb6efbbe6c930.zip
contributing: add section about C/C++ backend code
Diffstat (limited to 'docs/contributing/development.rst')
-rw-r--r--docs/contributing/development.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst
index 7d90ac0f..1f296144 100644
--- a/docs/contributing/development.rst
+++ b/docs/contributing/development.rst
@@ -682,6 +682,25 @@ Migrating old CLI
- None
- All logic should be in the scripts
+C++ Backend Code
+================
+
+The CLI parser used in VyOS is a mix of bash, bash-completion helper and the
+C++ backend library [vyatta-cfg](https://github.com/vyos/vyatta-cfg). This
+section is a reference of common CLI commands and the respective entry point
+in the C/C++ code.
+
+* ``set``
+
+ - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L352
+ - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L2549
+
+
+* ``commit``
+
+ - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/commit/commit-algorithm.cpp#L1252
+
+
Continuous Integration
======================