https://github.com/nemethf/bess-gen-doc
https://github.com/nemethf/bess-gen-doc
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nemethf/bess-gen-doc
- Owner: nemethf
- License: gpl-3.0
- Created: 2019-01-03T11:32:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-11T10:59:45.000Z (about 5 years ago)
- Last Synced: 2025-02-01T04:14:55.272Z (4 months ago)
- Language: Python
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generate documentation for Bess
As opposed to the [official
documentation](https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports),
this program generates documentation that
* lists every class method (dedicated protobuf message is not a
requirement)
* links c++ defintions and usage examples.
# Execution steps
1. Clone or update bess repository,
1. Compile bess with container_build,
1. Extract documentation from protobuf messages,
1. Collect modules and their methods by running bessd in a container,
1. Find method definitions by running gdb,
1. Write a dummy module ([globals.py](https://github.com/nemethf/pyls-bess/blob/master/pyls_bess/bess_doc/globals.py)).
# Uninstall
To remove the software, you also need to remove some docker images.
```
$ docker image rm gen-bess-doc-globals
$ docker image rm nefelinetworks/bess_build:latest-git
$ docker image rm nefelinetworks/bess_build
$ docker image rm pseudomuto/protoc-gen-doc
```
# Is it any good?
At least the [bess language
server](https://github.com/nemethf/pyls-bess) uses it.