Exception lib documentation
I have a question about the release procedure, do I need to do anything special to hook the Exception library documentation into the main Boost documentation? (The main Boost Exception documentation file is libs/exception/doc/boost-exception.html) Emil Dotchevski Reverge Studios, Inc. http://www.revergestudios.com/reblog/index.php?n=ReCode
On 01/07/2008, Emil Dotchevski <emil@revergestudios.com> wrote:
I have a question about the release procedure, do I need to do anything special to hook the Exception library documentation into the main Boost documentation?
It needs to added to a few places (not all documentation related): 1. the regression tests at status/Jamfile.v2 (I know you've done this, I'm including it for completeness). 2. libs/libraries.htm, under the the alphabetical list and under any appropriate categories. 3. libs/maintainers.txt 4. the release information, at https://svn.boost.org/svn/boost/website/public_html/beta/feed/history/boost_... 5. the website's list of libraries, at https://svn.boost.org/svn/boost/website/public_html/beta/doc/libraries.xml. You also need to create a forwarding file for your documentation at libs/exception/index.html. So if someone goes to http://www.boost.org/libs/exception they will get redirected to your library (just look in other libraries for examples). Daniel
Daniel, Thanks for the pointers. I did everything from the list you provided. Two things I should mention: - I took the liberty to edit the qbk file with a regular text editor and without knowing anything about its format. I hope I didn't mess it up. - I added Boost Exception into the alphabetical list in libraries.htm, but I am wondering if perhaps it needs its own category, Exception Handling or maybe Error Reporting? If not, it should probably go under Miscellaneous. Emil Dotchevski Reverge Studios, Inc. http://www.revergestudios.com/reblog/index.php?n=ReCode On Wed, Jul 2, 2008 at 10:50 AM, Daniel James <daniel_james@fmail.co.uk> wrote:
On 01/07/2008, Emil Dotchevski <emil@revergestudios.com> wrote:
I have a question about the release procedure, do I need to do anything special to hook the Exception library documentation into the main Boost documentation?
It needs to added to a few places (not all documentation related):
1. the regression tests at status/Jamfile.v2 (I know you've done this, I'm including it for completeness). 2. libs/libraries.htm, under the the alphabetical list and under any appropriate categories. 3. libs/maintainers.txt 4. the release information, at https://svn.boost.org/svn/boost/website/public_html/beta/feed/history/boost_... 5. the website's list of libraries, at https://svn.boost.org/svn/boost/website/public_html/beta/doc/libraries.xml.
You also need to create a forwarding file for your documentation at libs/exception/index.html. So if someone goes to http://www.boost.org/libs/exception they will get redirected to your library (just look in other libraries for examples).
Daniel _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
On 02/07/2008, Emil Dotchevski <emil@revergestudios.com> wrote:
- I took the liberty to edit the qbk file with a regular text editor and without knowing anything about its format. I hope I didn't mess it up.
It's fine. If there were any errors, we'd fix them. You don't have to learn quickbook.
- I added Boost Exception into the alphabetical list in libraries.htm, but I am wondering if perhaps it needs its own category, Exception Handling or maybe Error Reporting? If not, it should probably go under Miscellaneous.
I'd put it under Miscellaneous. Thinking back to what David Abrahams recently wrote, there should probably be a category for libraries like this one, the smart pointers, bind, iterator, utilities, operators, config, foreach etc. I'm not sure what to call them though, some possible ideas are: 'building blocks', 'basics', 'core', 'essentials'. Daniel
The serialization tests for Commeau compilers are failing due to some syntax error tripped in the exception library. I haven't investigated this yet, but I would appreciate it if someone knowledegable about the library were to take a look at it. Robert Ramey Emil Dotchevski wrote:
Daniel,
Thanks for the pointers.
I did everything from the list you provided. Two things I should mention:
- I took the liberty to edit the qbk file with a regular text editor and without knowing anything about its format. I hope I didn't mess it up.
- I added Boost Exception into the alphabetical list in libraries.htm, but I am wondering if perhaps it needs its own category, Exception Handling or maybe Error Reporting? If not, it should probably go under Miscellaneous.
Emil Dotchevski Reverge Studios, Inc. http://www.revergestudios.com/reblog/index.php?n=ReCode
On Wed, Jul 2, 2008 at 10:50 AM, Daniel James <daniel_james@fmail.co.uk> wrote:
On 01/07/2008, Emil Dotchevski <emil@revergestudios.com> wrote:
I have a question about the release procedure, do I need to do anything special to hook the Exception library documentation into the main Boost documentation?
It needs to added to a few places (not all documentation related):
1. the regression tests at status/Jamfile.v2 (I know you've done this, I'm including it for completeness). 2. libs/libraries.htm, under the the alphabetical list and under any appropriate categories. 3. libs/maintainers.txt 4. the release information, at https://svn.boost.org/svn/boost/website/public_html/beta/feed/history/boost_... 5. the website's list of libraries, at https://svn.boost.org/svn/boost/website/public_html/beta/doc/libraries.xml.
You also need to create a forwarding file for your documentation at libs/exception/index.html. So if someone goes to http://www.boost.org/libs/exception they will get redirected to your library (just look in other libraries for examples).
Daniel _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Can you point me to a log? With Como 4.3.10 on MSVC 9.0/Windows I get many boost type_traits/preprocessor-related and other compile errors trying to run the serialization library tests. I *think* my configuration is correct but my experience with Como is that I can never be sure. :) In the clutter, I might have missed the errors you're reporting so I'm attaching the complete log in case you want to take a peek. Emil Dotchevski Reverge Studios, Inc. http://www.revergestudios.com/reblog/index.php?n=ReCode On Wed, Jul 2, 2008 at 5:00 PM, Robert Ramey <ramey@rrsd.com> wrote:
The serialization tests for Commeau compilers are failing due to some syntax error tripped in the exception library. I haven't investigated this yet, but I would appreciate it if someone knowledegable about the library were to take a look at it.
Robert Ramey
Emil Dotchevski wrote:
Daniel,
Thanks for the pointers.
I did everything from the list you provided. Two things I should mention:
- I took the liberty to edit the qbk file with a regular text editor and without knowing anything about its format. I hope I didn't mess it up.
- I added Boost Exception into the alphabetical list in libraries.htm, but I am wondering if perhaps it needs its own category, Exception Handling or maybe Error Reporting? If not, it should probably go under Miscellaneous.
Emil Dotchevski Reverge Studios, Inc. http://www.revergestudios.com/reblog/index.php?n=ReCode
On Wed, Jul 2, 2008 at 10:50 AM, Daniel James <daniel_james@fmail.co.uk> wrote:
On 01/07/2008, Emil Dotchevski <emil@revergestudios.com> wrote:
I have a question about the release procedure, do I need to do anything special to hook the Exception library documentation into the main Boost documentation?
It needs to added to a few places (not all documentation related):
1. the regression tests at status/Jamfile.v2 (I know you've done this, I'm including it for completeness). 2. libs/libraries.htm, under the the alphabetical list and under any appropriate categories. 3. libs/maintainers.txt 4. the release information, at https://svn.boost.org/svn/boost/website/public_html/beta/feed/history/boost_... 5. the website's list of libraries, at https://svn.boost.org/svn/boost/website/public_html/beta/doc/libraries.xml.
You also need to create a forwarding file for your documentation at libs/exception/index.html. So if someone goes to http://www.boost.org/libs/exception they will get redirected to your library (just look in other libraries for examples).
Daniel _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
participants (3)
-
Daniel James -
Emil Dotchevski -
Robert Ramey