Skip to content

Commit 6df603a

Browse files
committed
doc CHANGE update info about yanglint
1 parent 46310e1 commit 6df603a

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@ providing API) in C. The library is used e.g. in [libnetconf2](https://github.co
1919
([RFC 7951](https://tools.ietf.org/html/rfc7951)).
2020
* Manipulation with the instance data.
2121
* Support for default values in the instance data ([RFC 6243](https://tools.ietf.org/html/rfc6243)).
22+
* [yanglint](#yanglint) - features rich YANG tool.
2223

2324
Current implementation covers YANG 1.0 ([RFC 6020](https://tools.ietf.org/html/rfc6020))
2425
as well as YANG 1.1 ([RFC 7950](https://tools.ietf.org/html/rfc7950)).
2526

2627
## Planned Features
2728

2829
* YANG Metadata ([RFC 7952](https://tools.ietf.org/html/rfc7952)).
29-
* [yanglint](#yanglint) as a full-fledged YANG tool.
30+
* Modular mechanism for supporting YANG extensions.
3031

3132
## Requirements
3233

@@ -52,6 +53,8 @@ $ make doc
5253
$ google-chrome ../doc/html/index.html
5354
```
5455

56+
The documentation is also built hourly and available at [netopeer.liberouter.org](https://netopeer.liberouter.org/doc/libyang/master/).
57+
5558
### Useful CMake Options
5659

5760
#### Changing Compiler
@@ -113,6 +116,16 @@ linker. To help with setting all the compiler's options, there is `libyang.pc` f
113116
If you are using `cmake` in you project, it is also possible to use the provided
114117
`FindLibYANG.cmake` file to detect presence of the libyang library in the system.
115118

119+
## yanglint
120+
121+
libyang project includes features rich tool called `yanglint(1)` for validation
122+
and conversion of the schemas and YANG modeled data. The source codes are
123+
located at [`/tools/lint`](./tools/lint) and can be used to explore how an
124+
application is supposed to use the libyang library. `yanglint(1)` binary as
125+
well as its man page are installed together with the library itself.
126+
127+
There is also [README](./tools/lint/examples/README.md) describing some examples of
128+
using `yanglint`.
116129

117130
## Tests
118131

@@ -157,14 +170,4 @@ Currently supported bindings are:
157170
* cmake option: `JAVASCRIPT_BINDING`
158171
* [README](./swig/javascript/README.md)
159172

160-
## yanglint
161-
162-
libyang source codes include a simple example tool to demanstrate how an application
163-
can work with the libyang library. The tool is called `yanglint`. It is not being
164-
installed together with the library itself, but it is built together with the library
165-
binary and you can find it in [`tools/lint`](./tools/lint) directory.
166-
167-
There is also [README](./tools/lint/examples/README.md) describing some examples of
168-
using `yanglint`.
169-
170173

0 commit comments

Comments
 (0)