aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-05-21 17:35:18 +0200
committerLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-05-21 17:35:18 +0200
commit386baba96aa18c8419c1ecea21a907ccc526a5fa (patch)
treefd1c803b9d29d5f558fa5f63b32e7c61570bbbbf
parentbaf385aae029bd7b7e30fe21fe4b12f0c5f634cb (diff)
parent47aa4bdcf62fff511153d37b5733d4b46b28d83d (diff)
downloadsparse-386baba96aa18c8419c1ecea21a907ccc526a5fa.tar.gz
Merge branch 'doc-update'
* doc: do not use obsolete sphinx's AutodocReporter
-rw-r--r--Documentation/TODO.md12
-rw-r--r--Documentation/nocast-vs-bitwise.md34
-rwxr-xr-xDocumentation/sphinx/cdoc.py10
3 files changed, 28 insertions, 28 deletions
diff --git a/Documentation/TODO.md b/Documentation/TODO.md
index cbda1c39..4344a1dc 100644
--- a/Documentation/TODO.md
+++ b/Documentation/TODO.md
@@ -24,15 +24,9 @@ Core
- add the sym into a list and
- recalculate the addressability before memops's SSA conversion
* bool_ctype should be split into internal 1-bit / external 8-bit
-* Previous declarations and the definition need to be merged. For example,
- in the code here below, the function definition is **not** static:
- ```
- static void foo(void);
- void foo(void) { ... }
- ```
Testsuite
---------
+---------
* there are more than 50 failing tests. They should be fixed
(but most are non-trivial to fix).
@@ -84,9 +78,13 @@ Longer term/to investigate
* should support "-Werror=..." ?
* All warning messages should include the option how to disable it.
For example:
+
"warning: Variable length array is used."
+
should be something like:
+
"warning: Variable length array is used. (-Wno-vla)"
+
* ptrlists must have elements be removed while being iterated but this
is hard to insure it is not done.
* having 'struct symbol' used to represent symbols *and* types is
diff --git a/Documentation/nocast-vs-bitwise.md b/Documentation/nocast-vs-bitwise.md
index b649abcd..9ba5a789 100644
--- a/Documentation/nocast-vs-bitwise.md
+++ b/Documentation/nocast-vs-bitwise.md
@@ -1,4 +1,5 @@
-# __nocast vs __bitwise
+__nocast vs __bitwise
+=====================
`__nocast` warns about explicit or implicit casting to different types.
HOWEVER, it doesn't consider two 32-bit integers to be different
@@ -16,25 +17,26 @@ harder to lose the type by mistake.
So the basic rule is:
- - `__nocast` on its own tends to be more useful for *big* integers
-that still need to act like integers, but you want to make it much
-less likely that they get truncated by mistake. So a 64-bit integer
-that you don't want to mistakenly/silently be returned as `int`, for
-example. But they mix well with random integer types, so you can add
-to them etc without using anything special. However, that mixing also
-means that the `__nocast` really gets lost fairly easily.
-
- - `__bitwise` is for *unique types* that cannot be mixed with other
-types, and that you'd never want to just use as a random integer (the
-integer `0` is special, though, and gets silently accepted - it's
-kind of like `NULL` for pointers). So `gfp_t` or the `safe endianness`
-types would be `__bitwise`: you can only operate on them by doing
-specific operations that know about *that* particular type.
+- `__nocast` on its own tends to be more useful for *big* integers
+ that still need to act like integers, but you want to make it much
+ less likely that they get truncated by mistake. So a 64-bit integer
+ that you don't want to mistakenly/silently be returned as `int`, for
+ example. But they mix well with random integer types, so you can add
+ to them etc without using anything special. However, that mixing also
+ means that the `__nocast` really gets lost fairly easily.
+
+- `__bitwise` is for *unique types* that cannot be mixed with other
+ types, and that you'd never want to just use as a random integer (the
+ integer `0` is special, though, and gets silently accepted - it's
+ kind of like `NULL` for pointers). So `gfp_t` or the `safe endianness`
+ types would be `__bitwise`: you can only operate on them by doing
+ specific operations that know about *that* particular type.
Generally, you want `__bitwise` if you are looking for type safety.
`__nocast` really is pretty weak.
-## Reference:
+Reference:
+----------
* Linus' e-mail about `__nocast` vs `__bitwise`:
diff --git a/Documentation/sphinx/cdoc.py b/Documentation/sphinx/cdoc.py
index 318e9b23..73c128cb 100755
--- a/Documentation/sphinx/cdoc.py
+++ b/Documentation/sphinx/cdoc.py
@@ -269,7 +269,7 @@ if __name__ == '__main__':
dump_doc(extract(sys.stdin, '<stdin>'))
-from sphinx.ext.autodoc import AutodocReporter
+from sphinx.util.docutils import switch_source_input
import docutils
import os
class CDocDirective(docutils.parsers.rst.Directive):
@@ -294,13 +294,13 @@ class CDocDirective(docutils.parsers.rst.Directive):
## let parse this new reST content
memo = self.state.memo
- save = memo.reporter, memo.title_styles, memo.section_level
- memo.reporter = AutodocReporter(lst, memo.reporter)
+ save = memo.title_styles, memo.section_level
node = docutils.nodes.section()
try:
- self.state.nested_parse(lst, 0, node, match_titles=1)
+ with switch_source_input(self.state, lst):
+ self.state.nested_parse(lst, 0, node, match_titles=1)
finally:
- memo.reporter, memo.title_styles, memo.section_level = save
+ memo.title_styles, memo.section_level = save
return node.children
def setup(app):