diff options
author | marxin <mliska@suse.cz> | 2022-07-25 10:52:56 +0200 |
---|---|---|
committer | Martin Liska <mliska@suse.cz> | 2022-07-28 12:37:03 +0200 |
commit | ea1a4694e5a1a07a1545338c34b792d9274ecbd1 (patch) | |
tree | a633d25ceb0f3119ef43058e08337bddd22c4b65 | |
parent | 1e2c5f4c2d13346e2181ebe65d2fa84f2184de07 (diff) | |
download | gcc-ea1a4694e5a1a07a1545338c34b792d9274ecbd1.zip gcc-ea1a4694e5a1a07a1545338c34b792d9274ecbd1.tar.gz gcc-ea1a4694e5a1a07a1545338c34b792d9274ecbd1.tar.bz2 |
jit,docs: use enum directive for enumeral types
gcc/jit/ChangeLog:
* docs/conf.py: Add needs_sphinx = '3.0' where c:type was added.
* docs/index.rst: Remove note about it.
* docs/topics/compilation.rst: Use enum directive and reference.
* docs/topics/contexts.rst: Likewise.
* docs/topics/expressions.rst: Likewise.
* docs/topics/functions.rst: Likewise.
-rw-r--r-- | gcc/jit/docs/conf.py | 3 | ||||
-rw-r--r-- | gcc/jit/docs/index.rst | 7 | ||||
-rw-r--r-- | gcc/jit/docs/topics/compilation.rst | 4 | ||||
-rw-r--r-- | gcc/jit/docs/topics/contexts.rst | 6 | ||||
-rw-r--r-- | gcc/jit/docs/topics/expressions.rst | 10 | ||||
-rw-r--r-- | gcc/jit/docs/topics/functions.rst | 2 |
6 files changed, 14 insertions, 18 deletions
diff --git a/gcc/jit/docs/conf.py b/gcc/jit/docs/conf.py index 00f0e98..062232a 100644 --- a/gcc/jit/docs/conf.py +++ b/gcc/jit/docs/conf.py @@ -39,6 +39,9 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' +# c:type directive is supported since 3.0 +needs_sphinx = '3.0' + # General information about the project. project = u'libgccjit' copyright = u'2014-2022 Free Software Foundation, Inc.' diff --git a/gcc/jit/docs/index.rst b/gcc/jit/docs/index.rst index 3aff17d..21c3140 100644 --- a/gcc/jit/docs/index.rst +++ b/gcc/jit/docs/index.rst @@ -45,10 +45,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -.. Some notes: - - The Sphinx C domain appears to lack explicit support for enum values, - so I've been using :c:macro: for them. - - See https://sphinx-doc.org/domains.html#the-c-domain diff --git a/gcc/jit/docs/topics/compilation.rst b/gcc/jit/docs/topics/compilation.rst index 9b1eed2..c5fa6eb 100644 --- a/gcc/jit/docs/topics/compilation.rst +++ b/gcc/jit/docs/topics/compilation.rst @@ -158,14 +158,14 @@ For linking in object files, use :c:func:`gcc_jit_context_add_driver_option`. :c:func:`gcc_jit_context_compile_to_file` ignores the suffix of ``output_path``, and insteads uses the given -:c:type:`enum gcc_jit_output_kind` to decide what to do. +:c:enum:`gcc_jit_output_kind` to decide what to do. .. note:: This is different from the ``gcc`` program, which does make use of the suffix of the output file when determining what to do. -.. type:: enum gcc_jit_output_kind +.. enum:: gcc_jit_output_kind The available kinds of output are: diff --git a/gcc/jit/docs/topics/contexts.rst b/gcc/jit/docs/topics/contexts.rst index dfbe968..205b5f3 100644 --- a/gcc/jit/docs/topics/contexts.rst +++ b/gcc/jit/docs/topics/contexts.rst @@ -311,7 +311,7 @@ String Options Set a string option of the context. - .. type:: enum gcc_jit_str_option + .. enum:: gcc_jit_str_option The parameter ``value`` can be NULL. If non-NULL, the call takes a copy of the underlying string, so it is valid to pass in a pointer to @@ -334,7 +334,7 @@ Boolean options Set a boolean option of the context. Zero is "false" (the default), non-zero is "true". - .. type:: enum gcc_jit_bool_option + .. enum:: gcc_jit_bool_option .. macro:: GCC_JIT_BOOL_OPTION_DEBUGINFO @@ -513,7 +513,7 @@ Integer options Set an integer option of the context. - .. type:: enum gcc_jit_int_option + .. enum:: gcc_jit_int_option There is just one integer option specified this way: diff --git a/gcc/jit/docs/topics/expressions.rst b/gcc/jit/docs/topics/expressions.rst index 91ee8a9..49b7e14 100644 --- a/gcc/jit/docs/topics/expressions.rst +++ b/gcc/jit/docs/topics/expressions.rst @@ -309,7 +309,7 @@ Unary Operations The parameter ``result_type`` must be a numeric type. -.. type:: enum gcc_jit_unary_op +.. enum:: gcc_jit_unary_op The available unary operations are: @@ -376,7 +376,7 @@ Binary Operations The parameter ``result_type`` must be a numeric type. -.. type:: enum gcc_jit_binary_op +.. enum:: gcc_jit_binary_op The available binary operations are: @@ -534,7 +534,7 @@ Comparisons Build a boolean rvalue out of the comparison of two other rvalues. -.. type:: enum gcc_jit_comparison +.. enum:: gcc_jit_comparison ======================================= ============ Comparison C equivalent @@ -711,7 +711,7 @@ where the rvalue is computed by reading from the storage area. The "model" parameter determines the thread-local storage model of the "lvalue": - .. type:: enum gcc_jit_tls_model + .. enum:: gcc_jit_tls_model .. c:macro:: GCC_JIT_TLS_MODEL_NONE @@ -841,7 +841,7 @@ Global variables The "kind" parameter determines the visibility of the "global" outside of the :c:type:`gcc_jit_result`: - .. type:: enum gcc_jit_global_kind + .. enum:: gcc_jit_global_kind .. c:macro:: GCC_JIT_GLOBAL_EXPORTED diff --git a/gcc/jit/docs/topics/functions.rst b/gcc/jit/docs/topics/functions.rst index 0845fe0..d6d4fe9 100644 --- a/gcc/jit/docs/topics/functions.rst +++ b/gcc/jit/docs/topics/functions.rst @@ -80,7 +80,7 @@ Functions Create a gcc_jit_function with the given name and parameters. - .. type:: enum gcc_jit_function_kind + .. enum:: gcc_jit_function_kind This enum controls the kind of function created, and has the following values: |