Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
andreas-zeller committed Jul 1, 2024
1 parent 1c0a40b commit 14028f5
Show file tree
Hide file tree
Showing 147 changed files with 31,808 additions and 45,488 deletions.
2 changes: 1 addition & 1 deletion docs/beta/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -12124,7 +12124,7 @@

<div class="output_subarea output_stream output_stderr output_text">
<pre>Traceback (most recent call last):
File &#34;/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_36100/1830731544.py&#34;, line 4, in &lt;cell line: 3&gt;
File &#34;/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_67647/1830731544.py&#34;, line 4, in &lt;cell line: 3&gt;
raise NotFoundError
NotFoundError: &#39;404&#39; (expected)
</pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/01_Intro.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part I: Whetting Your Appetite" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/01_Intro.html
# Last change: 2024-05-16 15:58:42+02:00
# Last change: 2024-06-30 19:19:31+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/02_Observing.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part II: Observing Executions" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/02_Observing.html
# Last change: 2024-05-16 15:59:08+02:00
# Last change: 2024-06-30 19:19:53+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/03_Dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part III: Flows and Dependencies" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/03_Dependencies.html
# Last change: 2024-05-16 16:00:02+02:00
# Last change: 2024-06-30 19:20:29+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/04_Reducing.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part IV: Reducing Failure Causes" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/04_Reducing.html
# Last change: 2024-05-16 16:00:37+02:00
# Last change: 2024-06-30 19:20:56+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/05_Abstracting.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part V: Abstracting Failures" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/05_Abstracting.html
# Last change: 2024-05-16 16:01:11+02:00
# Last change: 2024-06-30 19:21:26+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/06_Repairing.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part VI: Automatic Repair" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/06_Repairing.html
# Last change: 2024-05-16 16:14:47+02:00
# Last change: 2024-06-30 19:27:58+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/07_In_the_Large.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Part VII: Debugging in the Large" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/07_In_the_Large.html
# Last change: 2024-05-16 16:15:58+02:00
# Last change: 2024-06-30 19:28:07+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/99_Appendices.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Appendices" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/99_Appendices.html
# Last change: 2024-05-16 16:32:14+02:00
# Last change: 2024-06-30 19:30:06+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
12 changes: 6 additions & 6 deletions docs/beta/code/Assertions.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Asserting Expectations" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Assertions.html
# Last change: 2024-05-16 15:59:55+02:00
# Last change: 2024-06-30 19:20:25+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -55,9 +55,9 @@
>>> with ExpectError():
>>> y = my_square_root(-1)
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69408/76616918.py", line 2, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_53336/76616918.py", line 2, in
y = my_square_root(-1)
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69408/2617682038.py", line 2, in my_square_root
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_53336/2617682038.py", line 2, in my_square_root
assert x >= 0
AssertionError (expected)
Expand All @@ -77,11 +77,11 @@
>>> with ExpectError():
>>> x = managed_mem[2]
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69408/1296110967.py", line 2, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_53336/1296110967.py", line 2, in
x = managed_mem[2]
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69408/2465984283.py", line 3, in __getitem__
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_53336/2465984283.py", line 3, in __getitem__
return self.read(address)
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69408/2898840933.py", line 9, in read
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_53336/2898840933.py", line 9, in read
assert self.allocated[address], \
AssertionError: Reading from unallocated memory (expected)
Expand Down
11 changes: 6 additions & 5 deletions docs/beta/code/ChangeCounter.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Where the Bugs are" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/ChangeCounter.html
# Last change: 2024-05-16 16:32:06+02:00
# Last change: 2024-06-30 18:57:45+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -60,12 +60,14 @@
A `change_counter` provides a number of attributes. `changes` is a mapping of nodes to the number of changes in that node:
>>> change_counter.changes.get(('README.md',), None)
19
20
The `messages` attribute holds all commit messages related to that node:
>>> change_counter.messages.get(('README.md',), None)
['Doc update',
'Doc update',
'Doc update',
'Doc update',
'Doc update',
'Doc update',
Expand All @@ -80,15 +82,14 @@
'Update',
'Doc update',
'Doc update',
'Doc update',
'Doc update',
'Updated README',
'Doc update',
'Doc update']
The `sizes` attribute holds the (last) size of the respective element:
>>> change_counter.sizes.get(('README.md',), None)
4731
4728
`FineChangeCounter` acts like `ChangeCounter`, but also retrieves statistics for elements _within_ the respective files; it has been tested for C, Python, and Jupyter Notebooks and should provide sufficient results for programming languages with similar syntax.
Expand Down
6 changes: 3 additions & 3 deletions docs/beta/code/ChangeDebugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Isolating Failure-Inducing Changes" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/ChangeDebugger.html
# Last change: 2024-05-16 16:01:06+02:00
# Last change: 2024-06-30 19:21:22+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -96,9 +96,9 @@ def remove_html_markup(s): # type: ignore
>>> with ExpectError(AssertionError):
>>> test()
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_71556/4262003862.py", line 3, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_54974/4262003862.py", line 3, in
test()
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_71556/3045937450.py", line 2, in test
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_54974/3045937450.py", line 2, in test
assert remove_html_markup('"foo"') == '"foo"'
AssertionError (expected)
Expand Down
6 changes: 5 additions & 1 deletion docs/beta/code/ClassDiagram.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Class Diagrams" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/ClassDiagram.html
# Last change: 2024-05-16 16:32:53+02:00
# Last change: 2024-06-30 18:57:54+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -451,6 +451,10 @@ def display_class_hierarchy(classes: Union[Type, List[Type]], *,
dot.attr('node', shape='record', fontname=CLASS_FONT)
dot.attr('graph', rankdir='BT', tooltip=title)
dot.attr('edge', arrowhead='empty')

# Hack to force rendering as HTML, allowing hovers and links in Jupyter
dot._repr_html_ = dot._repr_image_svg_xml

edges = set()
overloaded_methods: Set[str] = set()

Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/DDSetDebugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Generalizing Failure Circumstances" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/DDSetDebugger.html
# Last change: 2024-05-16 16:01:58+02:00
# Last change: 2024-06-30 19:22:02+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Debugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "How Debuggers Work" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Debugger.html
# Last change: 2024-05-16 15:59:28+02:00
# Last change: 2024-06-30 19:20:09+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
6 changes: 3 additions & 3 deletions docs/beta/code/DeltaDebugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Reducing Failure-Inducing Inputs" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/DeltaDebugger.html
# Last change: 2024-05-16 16:00:48+02:00
# Last change: 2024-06-30 19:21:06+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -51,9 +51,9 @@
>>> with ExpectError(ZeroDivisionError):
>>> myeval('1 + 2 * 3 / 0')
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_71194/4002351332.py", line 2, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_54673/4002351332.py", line 2, in
myeval('1 + 2 * 3 / 0')
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_71194/2200911420.py", line 2, in myeval
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_54673/2200911420.py", line 2, in myeval
return eval(inp)
File "", line 1, in
ZeroDivisionError: division by zero (expected)
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/DynamicInvariants.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Mining Function Specifications" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/DynamicInvariants.html
# Last change: 2024-05-16 16:01:42+02:00
# Last change: 2024-06-30 19:21:49+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
10 changes: 5 additions & 5 deletions docs/beta/code/ExpectError.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Error Handling" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/ExpectError.html
# Last change: 2024-05-16 16:32:37+02:00
# Last change: 2024-06-30 19:30:29+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -47,7 +47,7 @@
>>> with ExpectError():
>>> x = 1 / 0
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_33553/2664980466.py", line 2, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_65665/2664980466.py", line 2, in
x = 1 / 0
ZeroDivisionError: division by zero (expected)
Expand All @@ -63,11 +63,11 @@
3 seconds have passed
Traceback (most recent call last):
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_33553/1223755941.py", line 2, in
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_65665/1223755941.py", line 2, in
long_running_test()
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_33553/3930412460.py", line 4, in long_running_test
File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_65665/3930412460.py", line 4, in long_running_test
time.sleep(1)
File "/Users/zeller/Projects/debuggingbook/notebooks/Timeout.ipynb", line 43, in timeout_handler
File "Timeout.ipynb", line 43, in timeout_handler
raise TimeoutError()
TimeoutError (expected)
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Intro_Debugging.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Introduction to Debugging" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Intro_Debugging.html
# Last change: 2024-05-16 15:59:04+02:00
# Last change: 2024-06-30 19:19:49+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
14 changes: 7 additions & 7 deletions docs/beta/code/PerformanceDebugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Debugging Performance Issues" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/PerformanceDebugger.html
# Last change: 2024-05-16 16:14:43+02:00
# Last change: 2024-06-30 19:27:54+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -56,17 +56,17 @@
240 1% quote = False
241 1% out = ""
242 0%
243 17% for c in s:
243 16% for c in s:
244 15% assert tag or not quote
245 0%
246 15% if c == '' and not quote:
249 3% tag = False
250 9% elif (c == '"' or c == "'") and tag:
246 14% if c == '' and not quote:
249 2% tag = False
250 8% elif (c == '"' or c == "'") and tag:
251 0% quote = not quote
252 9% elif not tag:
253 4% out = out + c
253 5% out = out + c
254 0%
255 3% return out
255 2% return out
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Repairer.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Repairing Code Automatically" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Repairer.html
# Last change: 2024-05-16 16:15:54+02:00
# Last change: 2024-06-30 18:45:54+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Slicer.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Tracking Failure Origins" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Slicer.html
# Last change: 2024-06-29 18:08:13+02:00
# Last change: 2024-06-30 19:20:52+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/StackInspector.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Inspecting Call Stacks" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/StackInspector.html
# Last change: 2024-05-16 16:32:58+02:00
# Last change: 2024-06-30 18:58:00+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
4 changes: 2 additions & 2 deletions docs/beta/code/StatisticalDebugger.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Statistical Debugging" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/StatisticalDebugger.html
# Last change: 2024-05-16 16:01:25+02:00
# Last change: 2024-06-30 19:21:35+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -132,6 +132,7 @@
>>> debugger.rank()
[('remove_html_markup', 12),
('remove_html_markup', 3),
('remove_html_markup', 6),
('remove_html_markup', 9),
('remove_html_markup', 1),
('remove_html_markup', 4),
Expand All @@ -141,7 +142,6 @@
('remove_html_markup', 2),
('remove_html_markup', 11),
('remove_html_markup', 14),
('remove_html_markup', 6),
('remove_html_markup', 10),
('remove_html_markup', 8)]
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Timeout.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Timeout" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Timeout.html
# Last change: 2024-05-16 16:32:46+02:00
# Last change: 2024-06-30 19:30:38+02:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
Loading

0 comments on commit 14028f5

Please sign in to comment.