Opened 12 years ago
Last modified 9 years ago
#5391 new Feature Requests
Rework BBv2 documentation
Reported by: | René Rivera | Owned by: | Vladimir Prus |
---|---|---|---|
Milestone: | To Be Determined | Component: | build |
Version: | Boost Development Trunk | Severity: | Problem |
Keywords: | Cc: | mateusz@… |
Description
There's lots of complaints about the BBv2 documentation Artyom had the good recommendation to structure it as:
- General Concepts:
- Syntax
- Rules
- etc.
- Tutorial How to do common stuff:
- Build a program
- Build a library
- Build a test
- Configure things conditionally
- Create extensions
- And so on.
Pass on common features of Autotools, CMake, SCons and make sure users can easily figure out how to do.
- Full reference documentation:
- Properties
- Modules
- Rules
And so on. This is even more important then tutorial because user and search for specific functions rules if they documented but he can't if there is no docs.
As example I can provide ICU, their tutorials are very poor and basic but their reference docs are really great.
Change History (2)
comment:1 by , 12 years ago
Component: | None → build |
---|---|
Owner: | set to |
comment:2 by , 9 years ago
Cc: | added |
---|
Note:
See TracTickets
for help on using tickets.