The bnd manual did grow and improve recently, because it is now partly generated from the bnd Java Source Code, specifically the pages for Headers, Instructions and Commands on those overviews:
Highlights:
- There should be more pages and also pages with more information than before in a more consistent structure.
- Headers and Instructions are now generated from Syntax.java which contains a lot of information and is also used for Tooltips in BndEditor Source View
- Commands are generated from bnd.java which is basically the bnd CLI and contains all the commands and lots of Annotations with descriptions for parameters, sub-commands etc.
- There is an extension mechanism so that we can still add custom manual content for each generated page. You notice this, because the source-code snippets which are present on a lot of pages are still there.
- There is bnd/docs/generate.sh at master · bndtools/bnd · GitHub which needs to be run to re-generate the pages (the process is documented here bnd/docs at master · bndtools/bnd · GitHub)
Future work:
There are still some pages which for historical reasons display only some code snippets as explanantion. Those could still benefit from some prose and examples. There is currently PR Finetune docs with Copilot by chrisrueger · Pull Request #6663 · bndtools/bnd · GitHub to address this.
Help is welcome
If you want to change anything in the bnd manual
- first have a look at check out this page: bnd/docs at master · bndtools/bnd · GitHub
- If it is about bnd Headers or Instructions have a look at Syntax.java
- for bnd CLI commands check bnd.java and all those annotations like
@Description