Doc update

uds-se · Apr 30, 2024 · b120600 · b120600
1 parent ea7336d
commit b120600
Show file tree

Hide file tree

Showing 186 changed files with 20,545 additions and 20,081 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -11965,6 +11965,9 @@
     <article>
    <div tabindex="-1" id="notebook" class="border-box-sizing">
      <div class="container" id="notebook-container">
+<p><div class="banner">Help shaping the future of The Debugging Book and
+<a target=_new href="https://docs.google.com/forms/d/e/1FAIpQLScyO6j5EsrtS0pse7qVHeDoOj188JgC8SepWFZIO32N6gre8Q/viewform?usp=sf_link">take part in our 2024 reader survey!</a></div></p>
+
 
 <div class="input_markdown">
 <div class="cell border-box-sizing text_cell rendered">
@@ -12037,7 +12040,7 @@
 <div class="input_markdown">
 <div class="cell border-box-sizing text_cell rendered">
 <div class="inner_cell">
-<div class="text_cell_render border-box-sizing rendered_html"><h2 id="Getting-Informed-About-New-Content">Getting Informed About New Content<a class="anchor-link" href="#Getting-Informed-About-New-Content">&#182;</a></h2><p>New chapters are coming out every week.  To get notified when a new chapter (or this one) comes out, <a href="https://mastodon.social/invite/P27cijZH">follow us on Mastodon</a>.</p>
+<div class="text_cell_render border-box-sizing rendered_html"><h2 id="Getting-Informed-About-New-Content">Getting Informed About New Content<a class="anchor-link" href="#Getting-Informed-About-New-Content">&#182;</a></h2><p>New chapters are coming out every week.  To get notified when a new chapter (or this one) comes out, <a href="https://mastodon.social/@TheDebuggingBook">follow us on Mastodon</a>.</p>
 <!--
 <iframe allowfullscreen sandbox="allow-top-navigation allow-scripts allow-popups allow-popups-to-escape-sandbox" width="400" height="400" frameBorder="0" src="https://mastofeed.com/apiv2/feed?userurl=https%3A%2F%2Fmastodon.social%2Fusers%2FTheDebuggingBook&theme=auto&size=100&header=false&replies=false&boosts=false"></iframe>
 --></div>
@@ -12121,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_57103/1830731544.py&#34;, line 4, in &lt;cell line: 3&gt;
+  File &#34;/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_98074/1830731544.py&#34;, line 4, in &lt;cell line: 3&gt;
     raise NotFoundError
 NotFoundError: &#39;404&#39; (expected)
 </pre>
@@ -12135,7 +12138,7 @@
 The content of this project is licensed under the
 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
 The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/debuggingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
-<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/404.ipynb" target=_blank)>Last change: 2023-11-11 18:05:06+01:00</a> &bull; 
+<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/404.ipynb" target=_blank)>Last change: 2024-01-18 17:34:01+01:00</a> &bull; 
 <a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
 <a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
 </p>
@@ -12151,18 +12154,18 @@
 <a name="citation"></a>
 <h2>How to Cite this Work</h2>
 <p>
-Andreas Zeller: "<a href="https://www.debuggingbook.org/">The Debugging Book</a>".  Retrieved 2023-11-11 18:05:06+01:00.
+Andreas Zeller: "<a href="https://www.debuggingbook.org/">The Debugging Book</a>".  Retrieved 2024-01-18 17:34:01+01:00.
 </p>
 <pre>
-@book{debuggingbook2023,
+@book{debuggingbook2024,
     author = {Andreas Zeller},
     title = {The Debugging Book},
-    year = {2023},
+    year = {2024},
     publisher = {CISPA Helmholtz Center for Information Security},
     howpublished = {\url{https://www.debuggingbook.org/}},
-    note = {Retrieved 2023-11-11 18:05:06+01:00},
+    note = {Retrieved 2024-01-18 17:34:01+01:00},
     url = {https://www.debuggingbook.org/},
-    urldate = {2023-11-11 18:05:06+01:00}
+    urldate = {2024-01-18 17:34:01+01:00}
 }
 </pre>
 </div>

diff --git a/docs/code/01_Intro.py b/docs/code/01_Intro.py
@@ -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: 2023-11-12 13:39:12+01:00
+# Last change: 2024-01-17 22:30:54+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/02_Observing.py b/docs/code/02_Observing.py
@@ -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: 2023-11-12 13:39:37+01:00
+# Last change: 2024-01-17 22:31:17+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/03_Dependencies.py b/docs/code/03_Dependencies.py
@@ -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: 2023-11-12 13:40:15+01:00
+# Last change: 2024-01-17 22:31:47+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/04_Reducing.py b/docs/code/04_Reducing.py
@@ -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: 2023-11-12 13:40:43+01:00
+# Last change: 2024-01-17 22:32:13+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/05_Abstracting.py b/docs/code/05_Abstracting.py
@@ -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: 2023-11-12 13:41:16+01:00
+# Last change: 2024-01-17 22:32:42+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/06_Repairing.py b/docs/code/06_Repairing.py
@@ -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: 2023-11-12 13:47:25+01:00
+# Last change: 2024-01-17 22:38:47+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/07_In_the_Large.py b/docs/code/07_In_the_Large.py
@@ -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: 2023-11-12 13:48:39+01:00
+# Last change: 2024-01-17 22:39:56+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/99_Appendices.py b/docs/code/99_Appendices.py
@@ -3,7 +3,7 @@
 
 # "Appendices" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/99_Appendices.html
-# Last change: 2023-11-12 14:02:13+01:00
+# Last change: 2024-01-17 22:53:59+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/Assertions.py b/docs/code/Assertions.py
@@ -3,7 +3,7 @@
 
 # "Asserting Expectations" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/Assertions.html
-# Last change: 2023-11-12 13:40:07+01:00
+# Last change: 2024-01-17 22:31:42+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -55,9 +55,9 @@
 >>> with ExpectError():
 >>>     y = my_square_root(-1)
 Traceback (most recent call last):
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_22305/76616918.py", line 2, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_44916/76616918.py", line 2, in 
     y = my_square_root(-1)
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_22305/2617682038.py", line 2, in my_square_root
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_44916/2617682038.py", line 2, in my_square_root
     assert x >= 0
 AssertionError (expected)
 
@@ -77,11 +77,11 @@
 >>> with ExpectError():
 >>>     x = managed_mem[2]
 Traceback (most recent call last):
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_22305/1296110967.py", line 2, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_44916/1296110967.py", line 2, in 
     x = managed_mem[2]
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_22305/2465984283.py", line 3, in __getitem__
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_44916/2465984283.py", line 3, in __getitem__
     return self.read(address)
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_22305/2898840933.py", line 9, in read
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_44916/2898840933.py", line 9, in read
     assert self.allocated[address], \
 AssertionError: Reading from unallocated memory (expected)
 

diff --git a/docs/code/ChangeCounter.py b/docs/code/ChangeCounter.py
@@ -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: 2023-11-12 14:02:09+01:00
+# Last change: 2024-01-17 22:53:54+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -60,14 +60,12 @@
 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)
-17
+18
 
 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',
@@ -81,12 +79,15 @@
  'Updated README.md',
  'Update',
  'Doc update',
- 'Doc update']
+ 'Doc update',
+ 'Doc update',
+ 'Doc update',
+ 'Updated README']
 
 The `sizes` attribute holds the (last) size of the respective element:
 
 >>> change_counter.sizes.get(('README.md',), None)
-4614
+4729
 
 `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.
 

diff --git a/docs/code/ChangeDebugger.py b/docs/code/ChangeDebugger.py
@@ -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: 2023-11-12 13:41:11+01:00
+# Last change: 2024-01-17 22:32:38+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -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_25954/4262003862.py", line 3, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_46013/4262003862.py", line 3, in 
     test()
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_25954/3045937450.py", line 2, in test
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_46013/3045937450.py", line 2, in test
     assert remove_html_markup('"foo"') == '"foo"'
 AssertionError (expected)
 

diff --git a/docs/code/ClassDiagram.py b/docs/code/ClassDiagram.py
@@ -3,7 +3,7 @@
 
 # "Class Diagrams" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/ClassDiagram.html
-# Last change: 2023-11-12 14:02:52+01:00
+# Last change: 2024-01-17 22:54:41+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/DDSetDebugger.py b/docs/code/DDSetDebugger.py
@@ -3,7 +3,7 @@
 
 # "Generalizing Failure Circumstances" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/DDSetDebugger.html
-# Last change: 2023-11-12 13:41:55+01:00
+# Last change: 2024-01-17 22:33:18+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/Debugger.py b/docs/code/Debugger.py
@@ -3,7 +3,7 @@
 
 # "How Debuggers Work" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/Debugger.html
-# Last change: 2023-11-12 13:39:56+01:00
+# Last change: 2024-01-17 22:31:31+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/DeltaDebugger.py b/docs/code/DeltaDebugger.py
@@ -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: 2023-11-12 13:40:54+01:00
+# Last change: 2024-01-17 22:32:22+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -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_25735/4002351332.py", line 2, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_45795/4002351332.py", line 2, in 
     myeval('1 + 2 * 3 / 0')
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_25735/2200911420.py", line 2, in myeval
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_45795/2200911420.py", line 2, in myeval
     return eval(inp)
   File "", line 1, in 
 ZeroDivisionError: division by zero (expected)

diff --git a/docs/code/DynamicInvariants.py b/docs/code/DynamicInvariants.py
@@ -3,7 +3,7 @@
 
 # "Mining Function Specifications" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/DynamicInvariants.html
-# Last change: 2023-11-12 13:41:42+01:00
+# Last change: 2024-01-17 22:33:06+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/ExpectError.py b/docs/code/ExpectError.py
@@ -3,7 +3,7 @@
 
 # "Error Handling" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/ExpectError.html
-# Last change: 2023-11-12 14:02:36+01:00
+# Last change: 2024-01-17 22:54:25+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -47,7 +47,7 @@
 >>> with ExpectError():
 >>>     x = 1 / 0
 Traceback (most recent call last):
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_55153/2664980466.py", line 2, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69115/2664980466.py", line 2, in 
     x = 1 / 0
 ZeroDivisionError: division by zero (expected)
 
@@ -63,9 +63,9 @@
 3 seconds have passed
 
 Traceback (most recent call last):
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_55153/1223755941.py", line 2, in 
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69115/1223755941.py", line 2, in 
     long_running_test()
-  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_55153/3930412460.py", line 4, in long_running_test
+  File "/var/folders/n2/xd9445p97rb3xh7m1dfx8_4h0006ts/T/ipykernel_69115/3930412460.py", line 4, in long_running_test
     time.sleep(1)
   File "/Users/zeller/Projects/debuggingbook/notebooks/Timeout.ipynb", line 43, in timeout_handler
     raise TimeoutError()

diff --git a/docs/code/Intro_Debugging.py b/docs/code/Intro_Debugging.py
@@ -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: 2023-11-12 13:39:32+01:00
+# Last change: 2024-01-17 22:31:12+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/PerformanceDebugger.py b/docs/code/PerformanceDebugger.py
@@ -3,7 +3,7 @@
 
 # "Debugging Performance Issues" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/PerformanceDebugger.html
-# Last change: 2023-11-12 13:47:21+01:00
+# Last change: 2024-01-17 22:38:43+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors
@@ -59,14 +59,14 @@
  243  17%     for c in s:
  244  15%         assert tag or not quote
  245   0%
- 246  14%         if c == '' and not quote:
+ 246  15%         if c == '' and not quote:
  249   3%             tag = False
- 250   8%         elif (c == '"' or c == "'") and tag:
+ 250   9%         elif (c == '"' or c == "'") and tag:
  251   0%             quote = not quote
  252   9%         elif not tag:
- 253   5%             out = out + c
+ 253   4%             out = out + c
  254   0%
- 255   2%     return out
+ 255   3%     return out
 
 
 
@@ -186,7 +186,7 @@
 from .bookutils import quiz
 
 if __name__ == '__main__':
-    quiz('Donald J. Knuth said: "Premature optimization..."',
+    quiz('Donald E. Knuth said: "Premature optimization..."',
         [
             "... is the root of all evil",
             "... requires lots of experience",

diff --git a/docs/code/Repairer.py b/docs/code/Repairer.py
@@ -3,7 +3,7 @@
 
 # "Repairing Code Automatically" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/Repairer.html
-# Last change: 2023-11-12 13:48:34+01:00
+# Last change: 2024-01-17 22:39:52+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/Slicer.py b/docs/code/Slicer.py
@@ -3,7 +3,7 @@
 
 # "Tracking Failure Origins" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/Slicer.html
-# Last change: 2023-11-12 13:40:39+01:00
+# Last change: 2024-01-17 22:32:08+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors

diff --git a/docs/code/StackInspector.py b/docs/code/StackInspector.py
@@ -3,7 +3,7 @@
 
 # "Inspecting Call Stacks" - a chapter of "The Debugging Book"
 # Web site: https://www.debuggingbook.org/html/StackInspector.html
-# Last change: 2023-11-12 14:02:58+01:00
+# Last change: 2024-01-17 22:54:47+01:00
 #
 # Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
 # Copyright (c) 2018-2020 Saarland University, authors, and contributors