experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

code documentation

Browse source
This commit is contained in:
Olof hagsand 2020-07-12 10:59:12 +02:00
parent b655d56fb4
commit 25245a12d2
4 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -8,7 +8,7 @@ Clixon is a YANG-based configuration manager, with interactive CLI,
NETCONF and RESTCONF interfaces, an embedded database and transaction NETCONF and RESTCONF interfaces, an embedded database and transaction
mechanism. mechanism.
See [main documentation](https://clixon-docs.readthedocs.io), [project page](https://www.clicon.org) and [examples](https://github.com/clicon/clixon-examples). See [documentation](https://clixon-docs.readthedocs.io), [project page](https://www.clicon.org) and [examples](https://github.com/clicon/clixon-examples).
Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU
General Public License Version 2; you choose. General Public License Version 2; you choose.

1
lib/clixon/clixon_xml.h
View file

@ -114,7 +114,6 @@ enum cxobj_type {CX_ERROR=-1,
* x - - - - y * x - - - - y
* / \ / \ * / \ / \
* x1 x2 - - y1 y2 * x1 x2 - - y1 y2
* XXX: lacks support for incoming restconf rpc, see api_operations_post_input)
*/ */
enum yang_bind{ enum yang_bind{
YB_NONE=0, /* Dont do Yang binding */ YB_NONE=0, /* Dont do Yang binding */

6
lib/src/clixon_xml_bind.c
View file

@ -85,7 +85,7 @@
static int _yang_unknown_anydata = 0; static int _yang_unknown_anydata = 0;
/*! Kludge to equate unknown XML with anydata /*! Kludge to equate unknown XML with anydata
* The problem with this is that its global and shuld be bound to a handle * The problem with this is that its global and should be bound to a handle
*/ */
int int
xml_bind_yang_unknown_anydata(int val) xml_bind_yang_unknown_anydata(int val)
@ -305,6 +305,7 @@ populate_self_top(cxobj *xt,
* Populate xt:s children as top-level symbols * Populate xt:s children as top-level symbols
* This may be unnecessary if yspec is set on manual creation: x=xml_new(); xml_spec_set(x,y) * This may be unnecessary if yspec is set on manual creation: x=xml_new(); xml_spec_set(x,y)
* @param[in] xt XML tree node * @param[in] xt XML tree node
* @param[in] yb How to bind yang to XML top-level when parsing
* @param[in] yspec Yang spec * @param[in] yspec Yang spec
* @param[out] xerr Reason for failure, or NULL * @param[out] xerr Reason for failure, or NULL
* @retval 1 OK yang assignment made * @retval 1 OK yang assignment made
@ -348,7 +349,7 @@ xml_bind_yang(cxobj *xt,
goto done; goto done;
} }
int static int
xml_bind_yang0_opt(cxobj *xt, xml_bind_yang0_opt(cxobj *xt,
yang_bind yb, yang_bind yb,
cxobj *xsibling, cxobj *xsibling,
@ -428,6 +429,7 @@ xml_bind_yang0_opt(cxobj *xt,
* @retval 0 Partial or no yang assigment made (at least one failed) and xerr set * @retval 0 Partial or no yang assigment made (at least one failed) and xerr set
* @retval -1 Error * @retval -1 Error
* Populate xt as top-level node * Populate xt as top-level node
* @see xml_bind_yang If only children of xt should be populated, not xt itself
*/ */
int int
xml_bind_yang0(cxobj *xt, xml_bind_yang0(cxobj *xt,

1
lib/src/clixon_xml_map.c
View file

@ -1195,6 +1195,7 @@ xml2xpath1(cxobj *x,
* @param[out] xpath Malloced xpath string. Need to free() after use * @param[out] xpath Malloced xpath string. Need to free() after use
* @retval 0 OK * @retval 0 OK
* @retval -1 Error. (eg XML malformed) * @retval -1 Error. (eg XML malformed)
* @note x needs to be bound to YANG, see eg xml_bind_yang()
*/ */
int int
xml2xpath(cxobj *x, xml2xpath(cxobj *x,