Menu ▾ ▴

#617 Old-style documentation files inhibit start-up

v1.1.x
fixed
Erik Hänel
critical (96)
v1.1.3
Bug Fix
2021-08-02
2021-08-02
Erik Hänel
No

If someone has one or more old-style documentation files in his or her <>/docs folder, then these files will inhibit the start-up and lead to an early crash.

Analysis:

The issue is most assured in line 504 in doc_helper.cpp, which should be guarded by a try catch block, because the constructor of the DocumentationFile object may throw an error.

Implementation:

  • Implementation: Fix was performed as proposed by the analysis
  • Revision: [r935]
  • Implementation test: A startup with an old-style documentation file in the directory was performed without issues

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [ ] corresponding language files updated
    • [x] not needed

Tests:

Multiple start-ups without any deviation were performed.

Related

Commit: [r935]

Discussion

  • Erik Hänel

    Erik Hänel - 2021-08-02
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2021-08-02
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 If someone has one or more old-style documentation files in his or her `&lt;&gt;/docs` folder, then these files will inhibit the start-up and lead to an early crash.
+
+###Analysis:
+(*Describe, what&#39;s the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you&#39;ve changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2021-08-02
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 If someone has one or more old-style documentation files in his or her `&lt;&gt;/docs` folder, then these files will inhibit the start-up and lead to an early crash.

 ###Analysis:
-(*Describe, what&#39;s the issue and which changes have to be made*)
+The issue is most assured in line 504 in doc_helper.cpp, which should be guarded by a `try catch` block, because the constructor of the `DocumentationFile` object may throw an error.

 ###Implementation:

 * Implementation: (*Describe, what you&#39;ve changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2021-08-02
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 The issue is most assured in line 504 in doc_helper.cpp, which should be guarded by a `try catch` block, because the constructor of the `DocumentationFile` object may throw an error.

 ###Implementation:
-* Implementation: (*Describe, what you&#39;ve changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Fix was performed as proposed by the analysis
+* Revision: [r935]
+* Implementation test: A startup with an old-style documentation file in the directory was performed without issues

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
     * [ ] corresponding language files updated
-    * [ ] not needed
+    * [x] not needed

 ###Tests:
 (*Describe, which tests you performed and their outcome*)
    • status: implementing --> testing
     

    Related

    Commit: [r935]

  • Erik Hänel

    Erik Hänel - 2021-08-02

    Actually, the issue was an unmachted <br> in the documentation file, which produced this issue. However, the fix handles the real issue nevertheless.

     

  • Erik Hänel

    Erik Hänel - 2021-08-02
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Multiple start-ups without any deviation were performed.
    • status: testing --> fixed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB