Skip to content

Commit 27322af

Browse files
committed
adoc docs
1 parent 95b1ead commit 27322af

92 files changed

Lines changed: 4851 additions & 19701 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ jobs:
1717
fail-fast: false
1818
matrix:
1919
include:
20-
- toolset: gcc-4.8
21-
cxxstd: "11"
22-
os: ubuntu-latest
23-
container: ubuntu:18.04
24-
install: g++-4.8
2520
- toolset: gcc-5
2621
cxxstd: "11,14,1z"
2722
os: ubuntu-latest
@@ -38,14 +33,17 @@ jobs:
3833
container: ubuntu:18.04
3934
- toolset: gcc-8
4035
cxxstd: "11,14,17,2a"
41-
os: ubuntu-20.04
36+
os: ubuntu-latest
37+
container: ubuntu:20.04
4238
install: g++-8
4339
- toolset: gcc-9
4440
cxxstd: "11,14,17,2a"
45-
os: ubuntu-20.04
41+
os: ubuntu-latest
42+
container: ubuntu:20.04
4643
- toolset: gcc-10
4744
cxxstd: "11,14,17,2a"
48-
os: ubuntu-20.04
45+
os: ubuntu-latest
46+
container: ubuntu:20.04
4947
install: g++-10
5048
- toolset: gcc-11
5149
cxxstd: "11,14,17,2a"
@@ -64,6 +62,11 @@ jobs:
6462
os: ubuntu-latest
6563
container: ubuntu:24.04
6664
install: g++-14
65+
- toolset: gcc-15
66+
cxxstd: "11,14,17,20,23,2c"
67+
os: ubuntu-latest
68+
container: ubuntu:25.04
69+
install: g++-15
6770
- toolset: clang
6871
compiler: clang++-3.9
6972
cxxstd: "11,14"
@@ -85,35 +88,45 @@ jobs:
8588
- toolset: clang
8689
compiler: clang++-6.0
8790
cxxstd: "11,14,17"
88-
os: ubuntu-20.04
91+
os: ubuntu-latest
92+
container: ubuntu:20.04
8993
install: clang-6.0
9094
- toolset: clang
9195
compiler: clang++-7
9296
cxxstd: "11,14,17"
93-
os: ubuntu-20.04
97+
os: ubuntu-latest
98+
container: ubuntu:20.04
9499
install: clang-7
95100
- toolset: clang
96101
compiler: clang++-8
97102
cxxstd: "11,14,17"
98-
os: ubuntu-20.04
103+
os: ubuntu-latest
104+
container: ubuntu:20.04
99105
install: clang-8
100106
- toolset: clang
101107
compiler: clang++-9
102108
cxxstd: "11,14,17"
103-
os: ubuntu-20.04
109+
os: ubuntu-latest
110+
container: ubuntu:20.04
104111
install: clang-9
105112
- toolset: clang
106113
compiler: clang++-10
107114
cxxstd: "11,14,17,2a"
108-
os: ubuntu-20.04
115+
os: ubuntu-latest
116+
container: ubuntu:20.04
117+
install: clang-10
109118
- toolset: clang
110119
compiler: clang++-11
111120
cxxstd: "11,14,17,2a"
112-
os: ubuntu-20.04
121+
os: ubuntu-latest
122+
container: ubuntu:20.04
123+
install: clang-11
113124
- toolset: clang
114125
compiler: clang++-12
115126
cxxstd: "11,14,17,20"
116-
os: ubuntu-20.04
127+
os: ubuntu-latest
128+
container: ubuntu:20.04
129+
install: clang-12
117130
- toolset: clang
118131
compiler: clang++-13
119132
cxxstd: "11,14,17,20,2b"
@@ -153,18 +166,24 @@ jobs:
153166
- toolset: clang
154167
compiler: clang++-19
155168
cxxstd: "11,14,17,20,2b"
156-
container: ubuntu:24.10
169+
container: ubuntu:24.04
157170
os: ubuntu-latest
158171
install: clang-19
159172
- toolset: clang
160-
cxxstd: "11,14,17,20,2b"
161-
os: macos-13
173+
compiler: clang++-20
174+
cxxstd: "11,14,17,20,23,2c"
175+
container: ubuntu:25.04
176+
os: ubuntu-latest
177+
install: clang-20
162178
- toolset: clang
163179
cxxstd: "11,14,17,20,2b"
164180
os: macos-14
165181
- toolset: clang
166182
cxxstd: "11,14,17,20,2b"
167183
os: macos-15
184+
- toolset: clang
185+
cxxstd: "11,14,17,20,2b"
186+
os: macos-26
168187

169188
runs-on: ${{matrix.os}}
170189

@@ -237,14 +256,6 @@ jobs:
237256
fail-fast: false
238257
matrix:
239258
include:
240-
- toolset: msvc-14.0
241-
cxxstd: "14"
242-
addrmd: 32,64
243-
os: windows-2019
244-
- toolset: msvc-14.2
245-
cxxstd: "14,17,20,latest"
246-
addrmd: 32,64
247-
os: windows-2019
248259
- toolset: msvc-14.3
249260
cxxstd: "14,17,20,latest"
250261
addrmd: 32,64
@@ -256,7 +267,7 @@ jobs:
256267
- toolset: gcc
257268
cxxstd: "11,14,17,2a"
258269
addrmd: 64
259-
os: windows-2019
270+
os: windows-2022
260271

261272
runs-on: ${{matrix.os}}
262273

.github/workflows/gh-pages.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- develop
8+
9+
jobs:
10+
publish:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Install packages
16+
run: |
17+
sudo gem install asciidoctor asciidoctor-pdf rouge
18+
19+
- name: Setup Boost
20+
run: |
21+
REF=${GITHUB_BASE_REF:-$GITHUB_REF}
22+
BOOST_BRANCH=develop && [ "$REF" == "master" ] && BOOST_BRANCH=master || true
23+
cd ..
24+
git clone -b $BOOST_BRANCH --depth 1 https://github.com/boostorg/boost.git boost-root
25+
cd boost-root
26+
cp -r $GITHUB_WORKSPACE/* libs/exception
27+
git submodule update --init tools/build
28+
git submodule update --init tools/boost_install
29+
git submodule update --init libs/config
30+
./bootstrap.sh
31+
32+
- name: Create user-config.jam
33+
run: |
34+
echo "using asciidoctor ;" > ~/user-config.jam
35+
36+
- name: Build documentation
37+
run: |
38+
cd ../boost-root/libs/exception/doc
39+
../../../b2
40+
41+
- name: Deploy to GitHub Pages
42+
uses: JamesIves/github-pages-deploy-action@4.0.0
43+
with:
44+
token: ${{ secrets.GITHUB_TOKEN }}
45+
branch: gh-pages
46+
folder: ../boost-root/libs/exception/doc/html

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/.vscode/ipch/*
22
/.vscode/settings.json
33
.DS_Store
4+
doc/html/index.html

doc/BOOST_THROW_EXCEPTION.html

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,10 @@
1-
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
2-
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
3-
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
1+
<!DOCTYPE html>
2+
<html>
43
<head>
5-
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
6-
<title>BOOST_THROW_EXCEPTION</title>
7-
<link href='reno.css' type='text/css' rel='stylesheet'/>
4+
<meta http-equiv="refresh" content="0; url=html/index.html#BOOST_THROW_EXCEPTION">
5+
<script>window.location.href = "html/index.html#BOOST_THROW_EXCEPTION";</script>
86
</head>
97
<body>
10-
<div class="body-0">
11-
<div class="body-1">
12-
<div class="body-2">
13-
<div>
14-
<div id="boost_logo">
15-
<a href="http://www.boost.org"><img style="border:0" src="../../../boost.png" alt="Boost" width="277" height="86"/></a>
16-
</div>
17-
<h1>Boost Exception</h1>
18-
</div>
19-
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
20-
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
21-
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
22-
<div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>BOOST_THROW_EXCEPTION</h3>
23-
</div>
24-
<p>Please see <a href="https://www.boost.org/doc/libs/release/libs/throw_exception/doc/html/throw_exception.html">Boost.ThrowException</a>.</p>
25-
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
26-
See also: <span class="RenoPageList"><a href="boost-exception.html">Boost Exception</a>&nbsp;| <a href="boost_throw_exception_hpp.html">boost/throw_exception.hpp</a>&nbsp;| <a href="configuration_macros.html">Configuration Macros</a>&nbsp;| <a href="frequently_asked_questions.html">Frequently Asked Questions</a></span>
27-
</div>
28-
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
29-
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
30-
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
31-
<div id="footer">
32-
<p>
33-
<a class="logo" href="http://jigsaw.w3.org/css-validator/check/referer"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>
34-
<a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>
35-
<small>Copyright (c) 2006-2009 by Emil Dotchevski and Reverge Studios, Inc.<br/>
36-
Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
37-
</p>
38-
</div>
39-
</div>
40-
</div>
41-
</div>
8+
<p>Redirecting to <a href="html/index.html#BOOST_THROW_EXCEPTION">index.html#BOOST_THROW_EXCEPTION</a>...</p>
429
</body>
4310
</html>

doc/Jamfile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Copyright 2006-2026 Emil Dotchevski and Reverge Studios, Inc.
2+
# Copyright 2017 Peter Dimov
3+
#
4+
# Distributed under the Boost Software License, Version 1.0.
5+
# (See accompanying file LICENSE_1_0.txt or copy at
6+
# http://www.boost.org/LICENSE_1_0.txt)
7+
8+
project doc/exception ;
9+
using asciidoctor ;
10+
11+
html index.html : exception.adoc : <asciidoctor-attribute>stylesheet=zajo-dark.css <asciidoctor-attribute>linkcss ;
12+
install html_ : index.html skin.png zajo-dark.css zajo-light.css rouge-github.css : <location>html ;
13+
14+
pdf exception.pdf : exception.adoc : <asciidoctor-doctype>book <asciidoctor-attribute>pdf-themesdir=. <asciidoctor-attribute>pdf-theme=exception ;
15+
install pdf_ : exception.pdf : <location>html ;
16+
17+
alias boostdoc ;
18+
explicit boostdoc ;
19+
alias boostrelease : html_ ;
20+
explicit boostrelease ;

doc/boost-exception.html

Lines changed: 5 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,10 @@
1-
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
2-
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
3-
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
1+
<!DOCTYPE html>
2+
<html>
43
<head>
5-
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
6-
<title>boost exception</title>
7-
<link href='reno.css' type='text/css' rel='stylesheet'/>
4+
<meta http-equiv="refresh" content="0; url=html/index.html#boost-exception">
5+
<script>window.location.href = "html/index.html";</script>
86
</head>
97
<body>
10-
<div class="body-0">
11-
<div class="body-1">
12-
<div class="body-2">
13-
<div>
14-
<div id="boost_logo">
15-
<a href="http://www.boost.org"><img style="border:0" src="boost.png" alt="Boost" width="277" height="86"/></a>
16-
</div>
17-
<h1>Boost Exception</h1>
18-
</div>
19-
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
20-
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
21-
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
22-
<p><b style="color:red"><u>NOTE</u>:</b> When targeting C++11 or newer and Boost 1.75 or newer is available, it is recommended to use <a href="https://www.boost.org/doc/libs/release/libs/leaf/doc/html/index.html">Boost LEAF</a> instead of Boost Exception. LEAF serves a similar purpose but it has a more elegant interface, it is more efficient, and works with or without exception handling -- yet understands Boost Exception error information for compatibility with legacy source code. This <a href="https://www.boost.org/doc/libs/release/libs/leaf/doc/html/index.html#boost_exception">overview</a> explains the differences between the two APIs (Boost Exception is <u>not</u> deprecated and will continue to be supported, including C++03 compatibility).</p>
23-
<div class="RenoIncludeDIV"><h2>Introduction</h2>
24-
<p>The purpose of Boost Exception is to ease the design of exception class hierarchies and to help write exception handling and error reporting code.</p>
25-
<p>It supports transporting of arbitrary data to the catch site, which is otherwise tricky due to the no-throw requirements (15.5.1) for exception types. Data can be added to any exception object, either directly in the throw-expression (15.1), or at a later time as the exception object propagates up the call stack.</p>
26-
<p>The ability to add data to exception objects after they have been passed to throw is important, because often some of the information needed to handle an exception is unavailable in the context where the failure is detected. </p>
27-
<p>Boost Exception also supports <span class="RenoLink"><a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2179.html">N2179</a></span>-style <span class="RenoLink"><a href="tutorial_exception_ptr.html">copying</a></span> of exception objects, implemented non-intrusively and automatically by the boost::<span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span> function.</p>
28-
<h2>Contents</h2>
29-
<div><ol><li><span class="RenoLink"><a href="motivation.html">Motivation</a></span></li>
30-
<li>Tutorial<div><ol><li><span class="RenoLink"><a href="tutorial_transporting_data.html">Transporting of Arbitrary Data to the Catch Site</a></span></li>
31-
<li><span class="RenoLink"><a href="tutorial_enable_error_info.html">Integrating Boost Exception in Existing Exception Class Hierarchies</a></span></li>
32-
<li><span class="RenoLink"><a href="tutorial_exception_ptr.html">Transporting of Exceptions Between Threads</a></span></li>
33-
<li><span class="RenoLink"><a href="exception_types_as_simple_semantic_tags.html">Exception Types as Simple Semantic Tags</a></span></li>
34-
<li><span class="RenoLink"><a href="using_virtual_inheritance_in_exception_types.html">Using Virtual Inheritance in Exception Types</a></span></li>
35-
<li><span class="RenoLink"><a href="tutorial_diagnostic_information.html">Diagnostic Information</a></span></li>
36-
</ol></div>
37-
</li>
38-
<li>Documentation<div><ol><li>Class <span class="RenoLink"><a href="exception.html">exception</a></span></li>
39-
<li>Throwing Exceptions<div><ol><li><span class="RenoLink"><a href="BOOST_THROW_EXCEPTION.html">BOOST_THROW_EXCEPTION</a></span></li>
40-
<li><span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span></li>
41-
</ol></div>
42-
</li>
43-
<li>Transporting of Arbitrary Data to the Catch Site<div><ol><li><span class="RenoLink"><a href="error_info.html">error_info</a></span></li>
44-
<li><span class="RenoLink"><a href="exception_operator_shl.html">exception/operator&lt;&lt;</a></span></li>
45-
<li><span class="RenoLink"><a href="tuple_operator_shl.html">tuple/operator&lt;&lt;</a></span></li>
46-
<li><span class="RenoLink"><a href="get_error_info.html">get_error_info</a></span></li>
47-
<li><span class="RenoLink"><a href="enable_error_info.html">enable_error_info</a></span></li>
48-
</ol></div>
49-
</li>
50-
<li><span class="RenoLink"><a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2179.html">N2179</a></span> Transporting of Exceptions between Threads<div><ol><li><span class="RenoLink"><a href="exception_ptr.html">exception_ptr</a></span></li>
51-
<li><span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span></li>
52-
<li><span class="RenoLink"><a href="current_exception.html">current_exception</a></span></li>
53-
<li><span class="RenoLink"><a href="copy_exception.html">copy_exception</a></span></li>
54-
<li><span class="RenoLink"><a href="rethrow_exception.html">rethrow_exception</a></span></li>
55-
<li><span class="RenoLink"><a href="unknown_exception.html">unknown_exception</a></span></li>
56-
</ol></div>
57-
</li>
58-
<li>Diagnostic Information<div><ol><li><span class="RenoLink"><a href="diagnostic_information.html">diagnostic_information</a></span></li>
59-
<li><span class="RenoLink"><a href="current_exception_diagnostic_information.html">current_exception_diagnostic_information</a></span></li>
60-
</ol></div>
61-
</li>
62-
<li><span class="RenoLink"><a href="current_exception_cast.html">current_exception_cast</a></span></li>
63-
</ol></div>
64-
</li>
65-
<li>API<div><ol><li><span class="RenoLink"><a href="synopsis.html">Synopsis</a></span></li>
66-
<li><span class="RenoLink"><a href="headers.html">Headers</a></span></li>
67-
<li><span class="RenoLink"><a href="types.html">Types</a></span></li>
68-
<li><span class="RenoLink"><a href="functions.html">Functions</a></span></li>
69-
<li><span class="RenoLink"><a href="macros.html">Macros</a></span></li>
70-
<li><span class="RenoLink"><a href="configuration_macros.html">Configuration Macros</a></span></li>
71-
</ol></div>
72-
</li>
73-
<li><span class="RenoLink"><a href="frequently_asked_questions.html">Frequently Asked Questions</a></span></li>
74-
<li><span class="RenoLink"><a href="page_idx.html">Page Index</a></span></li>
75-
</ol></div>
76-
<h3>Acknowledgements</h3>
77-
<p>Thanks to Peter Dimov for his continuing help. Also thanks to Tobias Schwinger, Tom Brinkman, Pavel Vozenilek and everyone who participated in the review process.</p>
78-
</div><!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
79-
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
80-
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
81-
<div id="footer">
82-
<p>
83-
<a class="logo" href="http://jigsaw.w3.org/css-validator/check/referer"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>
84-
<a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>
85-
<small>Copyright (c) 2006-2009 by Emil Dotchevski and Reverge Studios, Inc.<br/>
86-
Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
87-
</p>
88-
</div>
89-
</div>
90-
</div>
91-
</div>
8+
<p>Redirecting to <a href="html/index.html#boost-exception">index.html#boost-exception</a>...</p>
929
</body>
9310
</html>

0 commit comments

Comments
 (0)