Merge tag 'docs-5.12' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet:
"It has been a relatively quiet cycle in docsland.
- As promised, the minimum Sphinx version to build the docs is now
1.7, and we have dropped support for Python 2 entirely. That
allowed the removal of a bunch of compatibility code.
- A set of treewide warning fixups from Mauro that I applied after it
became clear nobody else was going to deal with them.
- The automarkup mechanism can now create cross-references from
relative paths to RST files.
- More translations, typo fixes, and warning fixes"
* tag 'docs-5.12' of git://git.lwn.net/linux: (75 commits)
docs: kernel-hacking: be more civil
docs: Remove the Microsoft rhetoric
Documentation/admin-guide: kernel-parameters: Update nohlt section
doc/admin-guide: fix spelling mistake: "perfomance" -> "performance"
docs: Document cross-referencing using relative path
docs: Enable usage of relative paths to docs on automarkup
docs: thermal: fix spelling mistakes
Documentation: admin-guide: Update kvm/xen config option
docs: Make syscalls' helpers naming consistent
coding-style.rst: Avoid comma statements
Documentation: /proc/loadavg: add 3 more field descriptions
Documentation/submitting-patches: Add blurb about backtraces in commit messages
Docs: drop Python 2 support
Move our minimum Sphinx version to 1.7
Documentation: input: define ABS_PRESSURE/ABS_MT_PRESSURE resolution as grams
scripts/kernel-doc: add internal hyperlink to DOC: sections
Update Documentation/admin-guide/sysctl/fs.rst
docs: Update DTB format references
docs: zh_CN: add iio index.rst translation
docs/zh_CN: add iio ep93xx_adc.rst translation
...
This commit is contained in:
@@ -79,7 +79,7 @@
|
||||
#endif
|
||||
|
||||
/**
|
||||
* TH_LOG(fmt, ...)
|
||||
* TH_LOG()
|
||||
*
|
||||
* @fmt: format string
|
||||
* @...: optional arguments
|
||||
@@ -113,12 +113,16 @@
|
||||
__FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* SKIP(statement, fmt, ...)
|
||||
* SKIP()
|
||||
*
|
||||
* @statement: statement to run after reporting SKIP
|
||||
* @fmt: format string
|
||||
* @...: optional arguments
|
||||
*
|
||||
* .. code-block:: c
|
||||
*
|
||||
* SKIP(statement, fmt, ...);
|
||||
*
|
||||
* This forces a "pass" after reporting why something is being skipped
|
||||
* and runs "statement", which is usually "return" or "goto skip".
|
||||
*/
|
||||
@@ -136,7 +140,7 @@
|
||||
} while (0)
|
||||
|
||||
/**
|
||||
* TEST(test_name) - Defines the test function and creates the registration
|
||||
* TEST() - Defines the test function and creates the registration
|
||||
* stub
|
||||
*
|
||||
* @test_name: test name
|
||||
@@ -155,7 +159,7 @@
|
||||
#define TEST(test_name) __TEST_IMPL(test_name, -1)
|
||||
|
||||
/**
|
||||
* TEST_SIGNAL(test_name, signal)
|
||||
* TEST_SIGNAL()
|
||||
*
|
||||
* @test_name: test name
|
||||
* @signal: signal number
|
||||
@@ -195,7 +199,7 @@
|
||||
struct __test_metadata __attribute__((unused)) *_metadata)
|
||||
|
||||
/**
|
||||
* FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
|
||||
* FIXTURE_DATA() - Wraps the struct name so we have one less
|
||||
* argument to pass around
|
||||
*
|
||||
* @datatype_name: datatype name
|
||||
@@ -212,7 +216,7 @@
|
||||
#define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
|
||||
|
||||
/**
|
||||
* FIXTURE(fixture_name) - Called once per fixture to setup the data and
|
||||
* FIXTURE() - Called once per fixture to setup the data and
|
||||
* register
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
@@ -239,7 +243,7 @@
|
||||
FIXTURE_DATA(fixture_name)
|
||||
|
||||
/**
|
||||
* FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
|
||||
* FIXTURE_SETUP() - Prepares the setup function for the fixture.
|
||||
* *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
@@ -265,7 +269,7 @@
|
||||
__attribute__((unused)) *variant)
|
||||
|
||||
/**
|
||||
* FIXTURE_TEARDOWN(fixture_name)
|
||||
* FIXTURE_TEARDOWN()
|
||||
* *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
@@ -286,7 +290,7 @@
|
||||
FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
|
||||
|
||||
/**
|
||||
* FIXTURE_VARIANT(fixture_name) - Optionally called once per fixture
|
||||
* FIXTURE_VARIANT() - Optionally called once per fixture
|
||||
* to declare fixture variant
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
@@ -305,7 +309,7 @@
|
||||
#define FIXTURE_VARIANT(fixture_name) struct _fixture_variant_##fixture_name
|
||||
|
||||
/**
|
||||
* FIXTURE_VARIANT_ADD(fixture_name, variant_name) - Called once per fixture
|
||||
* FIXTURE_VARIANT_ADD() - Called once per fixture
|
||||
* variant to setup and register the data
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
@@ -339,7 +343,7 @@
|
||||
_##fixture_name##_##variant_name##_variant =
|
||||
|
||||
/**
|
||||
* TEST_F(fixture_name, test_name) - Emits test registration and helpers for
|
||||
* TEST_F() - Emits test registration and helpers for
|
||||
* fixture-based test cases
|
||||
*
|
||||
* @fixture_name: fixture name
|
||||
|
||||
Reference in New Issue
Block a user