Skip to content

nemethf/bess-gen-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generate documentation for Bess

As opposed to the official documentation, 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,
  2. Compile bess with container_build,
  3. Extract documentation from protobuf messages,
  4. Collect modules and their methods by running bessd in a container,
  5. Find method definitions by running gdb,
  6. Write a dummy module (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 uses it.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published