[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-11 Thread Nathan Huckleberry via Phabricator via cfe-commits
This revision was automatically updated to reflect the committed changes.
Closed by commit rL365797: [Docs] Add standardized header links to analyzer doc 
(authored by Nathan-Huckleberry, committed by ).
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Changed prior to commit:
  https://reviews.llvm.org/D64543?vs=209105=209252#toc

Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543

Files:
  cfe/trunk/docs/analyzer/checkers.rst

Index: cfe/trunk/docs/analyzer/checkers.rst
===
--- cfe/trunk/docs/analyzer/checkers.rst
+++ cfe/trunk/docs/analyzer/checkers.rst
@@ -29,6 +29,8 @@
 null pointer dereference, usage of uninitialized values, etc.
 *These checkers must be always switched on as other checker rely on them.*
 
+.. _core-CallAndMessage:
+
 core.CallAndMessage (C, C++, ObjC)
 ""
  Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers).
@@ -36,6 +38,8 @@
 .. literalinclude:: checkers/callandmessage_example.c
 :language: objc
 
+.. _core-DivideZero:
+
 core.DivideZero (C, C++, ObjC)
 ""
  Check for division by zero.
@@ -43,6 +47,8 @@
 .. literalinclude:: checkers/dividezero_example.c
 :language: c
 
+.. _core-NonNullParamChecker:
+
 core.NonNullParamChecker (C, C++, ObjC)
 """
 Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute.
@@ -56,6 +62,8 @@
  f(p); // warn
  }
 
+.. _core-NullDereference:
+
 core.NullDereference (C, C++, ObjC)
 """
 Check for dereferences of null pointers.
@@ -99,6 +107,8 @@
obj->x = 1; // warn
  }
 
+.. _core-StackAddressEscape:
+
 core.StackAddressEscape (C)
 """
 Check that addresses to stack memory do not escape the function.
@@ -123,6 +133,8 @@
  }
 
 
+.. _core-UndefinedBinaryOperatorResult:
+
 core.UndefinedBinaryOperatorResult (C)
 ""
 Check for undefined results of binary operators.
@@ -134,6 +146,8 @@
int y = x + 1; // warn: left operand is garbage
  }
 
+.. _core-VLASize:
+
 core.VLASize (C)
 
 Check for declarations of Variable Length Arrays of undefined or zero size.
@@ -152,6 +166,8 @@
int vla2[x]; // warn: zero size
  }
 
+.. _core-uninitialized-ArraySubscript:
+
 core.uninitialized.ArraySubscript (C)
 "
 Check for uninitialized values used as array subscripts.
@@ -163,6 +179,8 @@
int x = a[i]; // warn: array subscript is undefined
  }
 
+.. _core-uninitialized-Assign:
+
 core.uninitialized.Assign (C)
 "
 Check for assigning uninitialized values.
@@ -174,6 +192,8 @@
x |= 1; // warn: left expression is uninitialized
  }
 
+.. _core-uninitialized-Branch:
+
 core.uninitialized.Branch (C)
 "
 Check for uninitialized values used as branch conditions.
@@ -186,6 +206,8 @@
  return;
  }
 
+.. _core-uninitialized-CapturedBlockVariable:
+
 core.uninitialized.CapturedBlockVariable (C)
 
 Check for blocks that capture uninitialized values.
@@ -197,6 +219,8 @@
^{ int y = x; }(); // warn
  }
 
+.. _core-uninitialized-UndefReturn:
+
 core.uninitialized.UndefReturn (C)
 ""
 Check for uninitialized values being returned to the caller.
@@ -216,10 +240,14 @@
 
 C++ Checkers.
 
+.. _cplusplus-InnerPointer:
+
 cplusplus.InnerPointer
 ""
 Check for inner pointers of C++ containers used after re/deallocation.
 
+.. _cplusplus-NewDelete:
+
 cplusplus.NewDelete (C++)
 "
 Check for double-free and use-after-free problems. Traces memory managed by new/delete.
@@ -227,6 +255,8 @@
 .. literalinclude:: checkers/newdelete_example.cpp
 :language: cpp
 
+.. _cplusplus-NewDeleteLeaks:
+
 cplusplus.NewDeleteLeaks (C++)
 ""
 Check for memory leaks. Traces memory managed by new/delete.
@@ -238,6 +268,8 @@
  } // warn
 
 
+.. _cplusplus-SelfAssignment:
+
 cplusplus.SelfAssignment (C++)
 ""
 Checks C++ copy and move assignment operators for self assignment.
@@ -249,6 +281,8 @@
 
 Dead Code Checkers.
 
+.. _deadcode-DeadStores:
+
 deadcode.DeadStores (C)
 """
 Check for values stored to variables that are never read afterwards.
@@ -267,6 +301,8 @@
 
 Objective C checkers that warn for null pointer passing and dereferencing errors.
 
+.. _nullability-NullPassedToNonnull:
+
 nullability.NullPassedToNonnull (ObjC)
 ""
 Warns when a null pointer is passed to a pointer which has a _Nonnull type.
@@ -278,6 +314,8 @@
  // Warning: nil passed to a 

[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-11 Thread Aaron Ballman via Phabricator via cfe-commits
aaron.ballman accepted this revision.
aaron.ballman added a comment.

LGTM! Do you need someone to commit on your behalf?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits


[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-11 Thread Kristóf Umann via Phabricator via cfe-commits
Szelethus accepted this revision.
Szelethus added a comment.
This revision is now accepted and ready to land.

Woohoo!


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits


[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-11 Thread Roman Lebedev via Phabricator via cfe-commits
lebedev.ri added a comment.

I like this!


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits


[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-10 Thread Nathan Huckleberry via Phabricator via cfe-commits
Nathan-Huckleberry updated this revision to Diff 209105.
Nathan-Huckleberry added a comment.

- Fix .m and i..


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543

Files:
  clang/docs/analyzer/checkers.rst

Index: clang/docs/analyzer/checkers.rst
===
--- clang/docs/analyzer/checkers.rst
+++ clang/docs/analyzer/checkers.rst
@@ -29,6 +29,8 @@
 null pointer dereference, usage of uninitialized values, etc.
 *These checkers must be always switched on as other checker rely on them.*
 
+.. _core-CallAndMessage:
+
 core.CallAndMessage (C, C++, ObjC)
 ""
  Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers).
@@ -36,6 +38,8 @@
 .. literalinclude:: checkers/callandmessage_example.c
 :language: objc
 
+.. _core-DivideZero:
+
 core.DivideZero (C, C++, ObjC)
 ""
  Check for division by zero.
@@ -43,6 +47,8 @@
 .. literalinclude:: checkers/dividezero_example.c
 :language: c
 
+.. _core-NonNullParamChecker:
+
 core.NonNullParamChecker (C, C++, ObjC)
 """
 Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute.
@@ -56,6 +62,8 @@
  f(p); // warn
  }
 
+.. _core-NullDereference:
+
 core.NullDereference (C, C++, ObjC)
 """
 Check for dereferences of null pointers.
@@ -99,6 +107,8 @@
obj->x = 1; // warn
  }
 
+.. _core-StackAddressEscape:
+
 core.StackAddressEscape (C)
 """
 Check that addresses to stack memory do not escape the function.
@@ -123,6 +133,8 @@
  }
 
 
+.. _core-UndefinedBinaryOperatorResult:
+
 core.UndefinedBinaryOperatorResult (C)
 ""
 Check for undefined results of binary operators.
@@ -134,6 +146,8 @@
int y = x + 1; // warn: left operand is garbage
  }
 
+.. _core-VLASize:
+
 core.VLASize (C)
 
 Check for declarations of Variable Length Arrays of undefined or zero size.
@@ -152,6 +166,8 @@
int vla2[x]; // warn: zero size
  }
 
+.. _core-uninitialized-ArraySubscript:
+
 core.uninitialized.ArraySubscript (C)
 "
 Check for uninitialized values used as array subscripts.
@@ -163,6 +179,8 @@
int x = a[i]; // warn: array subscript is undefined
  }
 
+.. _core-uninitialized-Assign:
+
 core.uninitialized.Assign (C)
 "
 Check for assigning uninitialized values.
@@ -174,6 +192,8 @@
x |= 1; // warn: left expression is uninitialized
  }
 
+.. _core-uninitialized-Branch:
+
 core.uninitialized.Branch (C)
 "
 Check for uninitialized values used as branch conditions.
@@ -186,6 +206,8 @@
  return;
  }
 
+.. _core-uninitialized-CapturedBlockVariable:
+
 core.uninitialized.CapturedBlockVariable (C)
 
 Check for blocks that capture uninitialized values.
@@ -197,6 +219,8 @@
^{ int y = x; }(); // warn
  }
 
+.. _core-uninitialized-UndefReturn:
+
 core.uninitialized.UndefReturn (C)
 ""
 Check for uninitialized values being returned to the caller.
@@ -216,10 +240,14 @@
 
 C++ Checkers.
 
+.. _cplusplus-InnerPointer:
+
 cplusplus.InnerPointer
 ""
 Check for inner pointers of C++ containers used after re/deallocation.
 
+.. _cplusplus-NewDelete:
+
 cplusplus.NewDelete (C++)
 "
 Check for double-free and use-after-free problems. Traces memory managed by new/delete.
@@ -227,6 +255,8 @@
 .. literalinclude:: checkers/newdelete_example.cpp
 :language: cpp
 
+.. _cplusplus-NewDeleteLeaks:
+
 cplusplus.NewDeleteLeaks (C++)
 ""
 Check for memory leaks. Traces memory managed by new/delete.
@@ -238,6 +268,8 @@
  } // warn
 
 
+.. _cplusplus-SelfAssignment:
+
 cplusplus.SelfAssignment (C++)
 ""
 Checks C++ copy and move assignment operators for self assignment.
@@ -249,6 +281,8 @@
 
 Dead Code Checkers.
 
+.. _deadcode-DeadStores:
+
 deadcode.DeadStores (C)
 """
 Check for values stored to variables that are never read afterwards.
@@ -267,6 +301,8 @@
 
 Objective C checkers that warn for null pointer passing and dereferencing errors.
 
+.. _nullability-NullPassedToNonnull:
+
 nullability.NullPassedToNonnull (ObjC)
 ""
 Warns when a null pointer is passed to a pointer which has a _Nonnull type.
@@ -278,6 +314,8 @@
  // Warning: nil passed to a callee that requires a non-null 1st parameter
  NSString *greeting = [@"Hello " stringByAppendingString:name];
 
+.. _nullability-NullReturnedFromNonnull:
+
 nullability.NullReturnedFromNonnull (ObjC)
 

[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-10 Thread Nathan Huckleberry via Phabricator via cfe-commits
Nathan-Huckleberry updated this revision to Diff 209104.
Nathan-Huckleberry added a comment.

- Fix file periods being converted to dashes


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543

Files:
  clang/docs/analyzer/checkers.rst

Index: clang/docs/analyzer/checkers.rst
===
--- clang/docs/analyzer/checkers.rst
+++ clang/docs/analyzer/checkers.rst
@@ -29,6 +29,8 @@
 null pointer dereference, usage of uninitialized values, etc.
 *These checkers must be always switched on as other checker rely on them.*
 
+.. _core-CallAndMessage:
+
 core.CallAndMessage (C, C++, ObjC)
 ""
  Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers).
@@ -36,6 +38,8 @@
 .. literalinclude:: checkers/callandmessage_example.c
 :language: objc
 
+.. _core-DivideZero:
+
 core.DivideZero (C, C++, ObjC)
 ""
  Check for division by zero.
@@ -43,6 +47,8 @@
 .. literalinclude:: checkers/dividezero_example.c
 :language: c
 
+.. _core-NonNullParamChecker:
+
 core.NonNullParamChecker (C, C++, ObjC)
 """
 Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute.
@@ -56,6 +62,8 @@
  f(p); // warn
  }
 
+.. _core-NullDereference:
+
 core.NullDereference (C, C++, ObjC)
 """
 Check for dereferences of null pointers.
@@ -99,6 +107,8 @@
obj->x = 1; // warn
  }
 
+.. _core-StackAddressEscape:
+
 core.StackAddressEscape (C)
 """
 Check that addresses to stack memory do not escape the function.
@@ -123,6 +133,8 @@
  }
 
 
+.. _core-UndefinedBinaryOperatorResult:
+
 core.UndefinedBinaryOperatorResult (C)
 ""
 Check for undefined results of binary operators.
@@ -134,6 +146,8 @@
int y = x + 1; // warn: left operand is garbage
  }
 
+.. _core-VLASize:
+
 core.VLASize (C)
 
 Check for declarations of Variable Length Arrays of undefined or zero size.
@@ -152,6 +166,8 @@
int vla2[x]; // warn: zero size
  }
 
+.. _core-uninitialized-ArraySubscript:
+
 core.uninitialized.ArraySubscript (C)
 "
 Check for uninitialized values used as array subscripts.
@@ -163,6 +179,8 @@
int x = a[i]; // warn: array subscript is undefined
  }
 
+.. _core-uninitialized-Assign:
+
 core.uninitialized.Assign (C)
 "
 Check for assigning uninitialized values.
@@ -174,6 +192,8 @@
x |= 1; // warn: left expression is uninitialized
  }
 
+.. _core-uninitialized-Branch:
+
 core.uninitialized.Branch (C)
 "
 Check for uninitialized values used as branch conditions.
@@ -186,6 +206,8 @@
  return;
  }
 
+.. _core-uninitialized-CapturedBlockVariable:
+
 core.uninitialized.CapturedBlockVariable (C)
 
 Check for blocks that capture uninitialized values.
@@ -197,6 +219,8 @@
^{ int y = x; }(); // warn
  }
 
+.. _core-uninitialized-UndefReturn:
+
 core.uninitialized.UndefReturn (C)
 ""
 Check for uninitialized values being returned to the caller.
@@ -216,10 +240,14 @@
 
 C++ Checkers.
 
+.. _cplusplus-InnerPointer:
+
 cplusplus.InnerPointer
 ""
 Check for inner pointers of C++ containers used after re/deallocation.
 
+.. _cplusplus-NewDelete:
+
 cplusplus.NewDelete (C++)
 "
 Check for double-free and use-after-free problems. Traces memory managed by new/delete.
@@ -227,6 +255,8 @@
 .. literalinclude:: checkers/newdelete_example.cpp
 :language: cpp
 
+.. _cplusplus-NewDeleteLeaks:
+
 cplusplus.NewDeleteLeaks (C++)
 ""
 Check for memory leaks. Traces memory managed by new/delete.
@@ -238,6 +268,8 @@
  } // warn
 
 
+.. _cplusplus-SelfAssignment:
+
 cplusplus.SelfAssignment (C++)
 ""
 Checks C++ copy and move assignment operators for self assignment.
@@ -249,6 +281,8 @@
 
 Dead Code Checkers.
 
+.. _deadcode-DeadStores:
+
 deadcode.DeadStores (C)
 """
 Check for values stored to variables that are never read afterwards.
@@ -267,6 +301,8 @@
 
 Objective C checkers that warn for null pointer passing and dereferencing errors.
 
+.. _nullability-NullPassedToNonnull:
+
 nullability.NullPassedToNonnull (ObjC)
 ""
 Warns when a null pointer is passed to a pointer which has a _Nonnull type.
@@ -278,6 +314,8 @@
  // Warning: nil passed to a callee that requires a non-null 1st parameter
  NSString *greeting = [@"Hello " stringByAppendingString:name];
 
+.. _nullability-NullReturnedFromNonnull:
+
 nullability.NullReturnedFromNonnull (ObjC)
 

[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-10 Thread Nathan Huckleberry via Phabricator via cfe-commits
Nathan-Huckleberry updated this revision to Diff 209103.
Nathan-Huckleberry added a comment.

- Fixed periods in sentences being dashes


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64543/new/

https://reviews.llvm.org/D64543

Files:
  clang/docs/analyzer/checkers.rst

Index: clang/docs/analyzer/checkers.rst
===
--- clang/docs/analyzer/checkers.rst
+++ clang/docs/analyzer/checkers.rst
@@ -29,20 +29,26 @@
 null pointer dereference, usage of uninitialized values, etc.
 *These checkers must be always switched on as other checker rely on them.*
 
+.. _core-CallAndMessage:
+
 core.CallAndMessage (C, C++, ObjC)
 ""
  Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers).
 
-.. literalinclude:: checkers/callandmessage_example.c
+.. literalinclude:: checkers/callandmessage_example-c
 :language: objc
 
+.. _core-DivideZero:
+
 core.DivideZero (C, C++, ObjC)
 ""
  Check for division by zero.
 
-.. literalinclude:: checkers/dividezero_example.c
+.. literalinclude:: checkers/dividezero_example-c
 :language: c
 
+.. _core-NonNullParamChecker:
+
 core.NonNullParamChecker (C, C++, ObjC)
 """
 Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute.
@@ -56,6 +62,8 @@
  f(p); // warn
  }
 
+.. _core-NullDereference:
+
 core.NullDereference (C, C++, ObjC)
 """
 Check for dereferences of null pointers.
@@ -99,6 +107,8 @@
obj->x = 1; // warn
  }
 
+.. _core-StackAddressEscape:
+
 core.StackAddressEscape (C)
 """
 Check that addresses to stack memory do not escape the function.
@@ -123,6 +133,8 @@
  }
 
 
+.. _core-UndefinedBinaryOperatorResult:
+
 core.UndefinedBinaryOperatorResult (C)
 ""
 Check for undefined results of binary operators.
@@ -134,6 +146,8 @@
int y = x + 1; // warn: left operand is garbage
  }
 
+.. _core-VLASize:
+
 core.VLASize (C)
 
 Check for declarations of Variable Length Arrays of undefined or zero size.
@@ -152,6 +166,8 @@
int vla2[x]; // warn: zero size
  }
 
+.. _core-uninitialized-ArraySubscript:
+
 core.uninitialized.ArraySubscript (C)
 "
 Check for uninitialized values used as array subscripts.
@@ -163,6 +179,8 @@
int x = a[i]; // warn: array subscript is undefined
  }
 
+.. _core-uninitialized-Assign:
+
 core.uninitialized.Assign (C)
 "
 Check for assigning uninitialized values.
@@ -174,6 +192,8 @@
x |= 1; // warn: left expression is uninitialized
  }
 
+.. _core-uninitialized-Branch:
+
 core.uninitialized.Branch (C)
 "
 Check for uninitialized values used as branch conditions.
@@ -186,6 +206,8 @@
  return;
  }
 
+.. _core-uninitialized-CapturedBlockVariable:
+
 core.uninitialized.CapturedBlockVariable (C)
 
 Check for blocks that capture uninitialized values.
@@ -197,6 +219,8 @@
^{ int y = x; }(); // warn
  }
 
+.. _core-uninitialized-UndefReturn:
+
 core.uninitialized.UndefReturn (C)
 ""
 Check for uninitialized values being returned to the caller.
@@ -216,17 +240,23 @@
 
 C++ Checkers.
 
+.. _cplusplus-InnerPointer:
+
 cplusplus.InnerPointer
 ""
 Check for inner pointers of C++ containers used after re/deallocation.
 
+.. _cplusplus-NewDelete:
+
 cplusplus.NewDelete (C++)
 "
 Check for double-free and use-after-free problems. Traces memory managed by new/delete.
 
-.. literalinclude:: checkers/newdelete_example.cpp
+.. literalinclude:: checkers/newdelete_example-cpp
 :language: cpp
 
+.. _cplusplus-NewDeleteLeaks:
+
 cplusplus.NewDeleteLeaks (C++)
 ""
 Check for memory leaks. Traces memory managed by new/delete.
@@ -238,6 +268,8 @@
  } // warn
 
 
+.. _cplusplus-SelfAssignment:
+
 cplusplus.SelfAssignment (C++)
 ""
 Checks C++ copy and move assignment operators for self assignment.
@@ -249,6 +281,8 @@
 
 Dead Code Checkers.
 
+.. _deadcode-DeadStores:
+
 deadcode.DeadStores (C)
 """
 Check for values stored to variables that are never read afterwards.
@@ -267,6 +301,8 @@
 
 Objective C checkers that warn for null pointer passing and dereferencing errors.
 
+.. _nullability-NullPassedToNonnull:
+
 nullability.NullPassedToNonnull (ObjC)
 ""
 Warns when a null pointer is passed to a pointer which has a _Nonnull type.
@@ -278,6 +314,8 @@
  // Warning: nil passed to a callee that requires a non-null 1st parameter
  NSString *greeting = [@"Hello " 

[PATCH] D64543: [Docs] Add standardized header links to analyzer doc

2019-07-10 Thread Nathan Huckleberry via Phabricator via cfe-commits
Nathan-Huckleberry created this revision.
Herald added subscribers: cfe-commits, dkrupp, donat.nagy, jfb, Szelethus, 
a.sidorin, mgrang, baloghadamsoftware.
Herald added a project: clang.

Header links should have some standard form so clang tidy
docs can easily reference them. The form is as follows.

Start with the analyzer full name including packages.
Replace all periods with dashes and lowercase everything.

Ex: core.CallAndMessage -> core-callandmessage


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D64543

Files:
  clang/docs/analyzer/checkers.rst

Index: clang/docs/analyzer/checkers.rst
===
--- clang/docs/analyzer/checkers.rst
+++ clang/docs/analyzer/checkers.rst
@@ -2,15 +2,15 @@
 Available Checkers
 ==
 
-The analyzer performs checks that are categorized into families or "checkers".
+The analyzer performs checks that are categorized into families or "checkers"-
 
 The default set of checkers covers a variety of checks targeted at finding security and API usage bugs,
-dead code, and other logic errors. See the :ref:`default-checkers` checkers list below.
+dead code, and other logic errors- See the :ref:`default-checkers` checkers list below-
 
-In addition to these, the analyzer contains a number of :ref:`alpha-checkers` (aka *alpha* checkers).
-These checkers are under development and are switched off by default. They may crash or emit a higher number of false positives.
+In addition to these, the analyzer contains a number of :ref:`alpha-checkers` (aka *alpha* checkers)-
+These checkers are under development and are switched off by default- They may crash or emit a higher number of false positives-
 
-The :ref:`debug-checkers` package contains checkers for analyzer developers for debugging purposes.
+The :ref:`debug-checkers` package contains checkers for analyzer developers for debugging purposes-
 
 .. contents:: Table of Contents
:depth: 4
@@ -26,26 +26,32 @@
 core
 
 Models core language features and contains general-purpose checkers such as division by zero,
-null pointer dereference, usage of uninitialized values, etc.
-*These checkers must be always switched on as other checker rely on them.*
+null pointer dereference, usage of uninitialized values, etc-
+*These checkers must be always switched on as other checker rely on them-*
 
-core.CallAndMessage (C, C++, ObjC)
+.. _core-CallAndMessage:
+
+core-CallAndMessage (C, C++, ObjC)
 ""
- Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers).
+ Check for logical errors for function calls and Objective-C message expressions (e-g-, uninitialized arguments, null function pointers)-
 
 .. literalinclude:: checkers/callandmessage_example.c
 :language: objc
 
-core.DivideZero (C, C++, ObjC)
+.. _core-DivideZero:
+
+core-DivideZero (C, C++, ObjC)
 ""
- Check for division by zero.
+ Check for division by zero-
 
 .. literalinclude:: checkers/dividezero_example.c
 :language: c
 
-core.NonNullParamChecker (C, C++, ObjC)
+.. _core-NonNullParamChecker:
+
+core-NonNullParamChecker (C, C++, ObjC)
 """
-Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute.
+Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute-
 
 .. code-block:: cpp
 
@@ -56,9 +62,11 @@
  f(p); // warn
  }
 
-core.NullDereference (C, C++, ObjC)
+.. _core-NullDereference:
+
+core-NullDereference (C, C++, ObjC)
 """
-Check for dereferences of null pointers.
+Check for dereferences of null pointers-
 
 .. code-block:: objc
 
@@ -99,9 +107,11 @@
obj->x = 1; // warn
  }
 
-core.StackAddressEscape (C)
+.. _core-StackAddressEscape:
+
+core-StackAddressEscape (C)
 """
-Check that addresses to stack memory do not escape the function.
+Check that addresses to stack memory do not escape the function-
 
 .. code-block:: c
 
@@ -123,9 +133,11 @@
  }
 
 
-core.UndefinedBinaryOperatorResult (C)
+.. _core-UndefinedBinaryOperatorResult:
+
+core-UndefinedBinaryOperatorResult (C)
 ""
-Check for undefined results of binary operators.
+Check for undefined results of binary operators-
 
 .. code-block:: c
 
@@ -134,11 +146,13 @@
int y = x + 1; // warn: left operand is garbage
  }
 
-core.VLASize (C)
+.. _core-VLASize:
+
+core-VLASize (C)
 
-Check for declarations of Variable Length Arrays of undefined or zero size.
+Check for declarations of Variable Length Arrays of undefined or zero size-
 
- Check for declarations of VLA of undefined or zero size.
+ Check for declarations of VLA of undefined or zero size-
 
 .. code-block:: c
 
@@ -152,9 +166,11 @@
int