Documentation build fixes against v5.10-rc1
Subsystems (29)
v3 cover Documentation build fixes against v5.10-rc1
Hi Jon,
This series contain the patches from a previous series I sent:
[PATCH v2 00/24] Documentation build fixes against next-20201013
Plus other patches I sent later, against other versions of linux-next between 20201013 and v5.10-rc1.
It fixes most of the remaining documentation build warnings.
There were some changes from v2, as I changed some patches due to the feedback received, and added reviewed-by/acked-by to several of them.
After this series, there will be just 3 warnings at include/kunit/test.h, whose fixes were already applied by Shuah via her tree at linux-next. Hopefully, she will be sending it upstream anytime toon. So, I dropped the fix from my trees.
The vast majority of patches here are also on my linux-next tree, as my original plan were to send them upstream by the end of the merge window. I'll drop from it once they get merged.
As those patches are fixes, I guess it should be ok to get them merged for -rc2 or -rc3.
Regards,
Mauro
Mauro Carvalho Chehab (32):
scripts: kernel-doc: use :c:union when needed
sphinx: conf.py: properly handle Sphinx 4.0
docs: hwmon: adm1266.rst: fix a broken reference
docs: admin-guide: net.rst: add a missing blank line
docs: kasan.rst: add two missing blank lines
docs: net: statistics.rst: remove a duplicated kernel-doc
docs: hwmon: mp2975.rst: address some html build warnings
docs: userspace-api: add iommu.rst to the index file
blk-mq: docs: add kernel-doc description for a new struct member
drm: kernel-doc: document drm_dp_set_subconnector_property() params drm/dp: fix kernel-doc warnings at drm_dp_helper.c drm/dp: fix a kernel-doc issue at drm_edid.c
mm: pagemap.h: fix two kernel-doc markups
net: phy: remove kernel-doc duplication
crypto: sun8x-ce*: update entries to its documentation
ice: docs fix a devlink info that broke a table
MAINTAINERS: fix broken doc refs due to yaml conversion
docs: lockdep-design: fix some warning issues locking/refcount: move kernel-doc markups to the proper place IB/srpt: docs: add a description for cq_size member
docs: fs: api-summary.rst: get rid of kernel-doc include
drm: amdgpu: kernel-doc: update some adev parameters
jbd2: fix a kernel-doc markup
drm: drm_edid: remove a duplicated kernel-doc declaration
drm: kernel-doc: add description for a new function parameter
gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups
drm: kernel-doc: drm_dp_helper.h: fix a typo
drm: amdgpu_dm: fix a typo
selftests: kselftest_harness.h: fix kernel-doc markups
amdgpu: fix a few kernel-doc markup issues
drm: drm_print.h: fix kernel-doc markups
docs: SafeSetID: fix a warning
Documentation/admin-guide/LSM/SafeSetID.rst | 2 +- Documentation/admin-guide/sysctl/net.rst | 1 + Documentation/conf.py | 2 +- Documentation/dev-tools/kasan.rst | 2 + .../bindings/clock/hi6220-clock.txt | 2 +- Documentation/filesystems/api-summary.rst | 3 - Documentation/gpu/amdgpu.rst | 7 - Documentation/hwmon/adm1266.rst | 2 +- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/mp2975.rst | 14 +- Documentation/locking/lockdep-design.rst | 51 +++--- Documentation/networking/devlink/ice.rst | 1 + Documentation/networking/statistics.rst | 3 +- Documentation/userspace-api/index.rst | 1 + MAINTAINERS | 9 +- .../crypto/allwinner/sun8i-ce/sun8i-ce-hash.c | 2 +- .../crypto/allwinner/sun8i-ce/sun8i-ce-prng.c | 2 +- .../crypto/allwinner/sun8i-ce/sun8i-ce-trng.c | 2 +- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 36 ++-- drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c | 6 +- drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c | 7 +- .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 2 +- .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 6 +- drivers/gpu/drm/drm_dp_helper.c | 12 +- drivers/gpu/drm/drm_edid.c | 2 +- drivers/gpu/drm/drm_prime.c | 1 + drivers/infiniband/ulp/srpt/ib_srpt.h | 1 + .../bindings/net/wireless/silabs,wfx.yaml | 2 +- include/drm/drm_dp_helper.h | 2 +- include/drm/drm_edid.h | 7 - include/drm/drm_print.h | 20 ++- include/linux/blk-mq.h | 2 + include/linux/jbd2.h | 2 +- include/linux/pagemap.h | 8 +- include/linux/phy.h | 40 +---- include/linux/refcount.h | 158 +++++++++--------- scripts/kernel-doc | 6 +- tools/testing/selftests/kselftest_harness.h | 44 ++--- 38 files changed, 242 insertions(+), 229 deletions(-)
Signature · 1 line
2.26.2
PATCH v3 1/32 scripts: kernel-doc: use :c:union when needed
Sphinx C domain code after 3.2.1 will start complaning if :c:struct would be used for an union type:
.../Documentation/gpu/drm-kms-helpers:352: ../drivers/video/hdmi.c:851: WARNING: C 'identifier' cross-reference uses wrong tag: reference name is 'union hdmi_infoframe' but found name is 'struct hdmi_infoframe'. Full reference name is 'union hdmi_infoframe'. Full found name is 'struct hdmi_infoframe'.
So, let's address this issue too in advance, in order to avoid future issues.
--- scripts/kernel-doc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
scripts/kernel-doc +5 -1
@@ -1092,7 +1092,11 @@ sub output_struct_rst(%) { print "\n\n.. c:type:: " . $name . "\n\n"; } else { my $name = $args{'struct'}; - print "\n\n.. c:struct:: " . $name . "\n\n"; + if ($args{'type'} eq 'union') { + print "\n\n.. c:union:: " . $name . "\n\n"; + } else { + print "\n\n.. c:struct:: " . $name . "\n\n"; + } } print_lineno($declaration_start_line); $lineprefix = " ";
Signature · 1 line
2.26.2
PATCH v3 2/32 sphinx: conf.py: properly handle Sphinx 4.0
In reply to Mauro Carvalho ChehabOne of the checks for Sphinx 3+ is broken, causing some C warnings to return back with Sphinx 4.0.x.
--- Documentation/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/conf.py +1 -1
@@ -50,7 +50,7 @@ if major >= 3: support for Sphinx v3.0 and above is brand new. Be prepared for possible issues in the generated output. ''') - if minor > 0 or patch >= 2: + if (major > 3) or (minor > 0 or patch >= 2): # Sphinx c function parser is more pedantic with regards to type # checking. Due to that, having macros at c:function cause problems. # Those needed to be scaped by using c_id_attributes[] array
Signature · 1 line
2.26.2
PATCH v3 3/32 docs: hwmon: adm1266.rst: fix a broken reference
In reply to Mauro Carvalho ChehabThe reference was missing the extension, causing the check script to complain.
--- Documentation/hwmon/adm1266.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/hwmon/adm1266.rst +1 -1
@@ -20,7 +20,7 @@ ADM1266 is a sequencer that features voltage readback from 17 channels via an integrated 12 bit SAR ADC, accessed using a PMBus interface. The driver is a client driver to the core PMBus driver. Please see -Documentation/hwmon/pmbus for details on PMBus client drivers. +Documentation/hwmon/pmbus.rst for details on PMBus client drivers. Sysfs entries
Signature · 1 line
2.26.2
PATCH v3 4/32 docs: admin-guide: net.rst: add a missing blank line
In reply to Mauro Carvalho ChehabThere's a missing blank line after a literal block, which causes this warning:
Documentation/admin-guide/sysctl/net.rst:303: WARNING: Literal block ends without a blank line; unexpected unindent.
--- Documentation/admin-guide/sysctl/net.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/sysctl/net.rst +1 -0
@@ -300,6 +300,7 @@ Note: 0: 0 1 2 3 4 5 6 7 RSS hash key: 84:50:f4:00:a8:15:d1:a7:e9:7f:1d:60:35:c7:47:25:42:97:74:ca:56:bb:b6:a1:d8:43:e3:c9:0c:fd:17:55:c2:3a:4d:69:ed:f1:42:89 + netdev_tstamp_prequeue ----------------------
Signature · 1 line
2.26.2
PATCH v3 5/32 docs: kasan.rst: add two missing blank lines
In reply to Mauro Carvalho Chehabliteral blocks should start and end with a blank line, as otherwise the parser complains and may do the wrong thing, as warned by Sphinx:
Documentation/dev-tools/kasan.rst:298: WARNING: Literal block ends without a blank line; unexpected unindent. Documentation/dev-tools/kasan.rst:303: WARNING: Literal block ends without a blank line; unexpected unindent.
--- Documentation/dev-tools/kasan.rst | 2 ++ 1 file changed, 2 insertions(+)
Documentation/dev-tools/kasan.rst +2 -0
@@ -295,11 +295,13 @@ print the number of the test and the status of the test: pass:: ok 28 - kmalloc_double_kzfree + or, if kmalloc failed:: # kmalloc_large_oob_right: ASSERTION FAILED at lib/test_kasan.c:163 Expected ptr is not null, but is not ok 4 - kmalloc_large_oob_right + or, if a KASAN report was expected, but not found:: # kmalloc_double_kzfree: EXPECTATION FAILED at lib/test_kasan.c:629
Signature · 1 line
2.26.2
PATCH v3 6/32 docs: net: statistics.rst: remove a duplicated kernel-doc
In reply to Mauro Carvalho Chehabinclude/linux/ethtool.h is included twice with kernel-doc, both to document ethtool_pause_stats(). The first one is at statistics.rst, and the second one at ethtool-netlink.rst.
Replace one of the references to use the name of the function. The automarkup.py extension should create the cross-references.
Solves this warning:
../Documentation/networking/ethtool-netlink.rst: WARNING: Duplicate C declaration, also defined in 'networking/statistics'. Declaration is 'ethtool_pause_stats'.
--- Documentation/networking/statistics.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/networking/statistics.rst +1 -2
@@ -175,5 +175,4 @@ The following structures are internal to the kernel, their members are translated to netlink attributes when dumped. Drivers must not overwrite the statistics they don't report with 0. -.. kernel-doc:: include/linux/ethtool.h - :identifiers: ethtool_pause_stats +- ethtool_pause_stats()
Signature · 1 line
2.26.2
PATCH v3 7/32 docs: hwmon: mp2975.rst: address some html build warnings
In reply to Mauro Carvalho Chehab .../Documentation/hwmon/mp2975.rst:25: WARNING: Unexpected indentation. .../Documentation/hwmon/mp2975.rst:27: WARNING: Block quote ends without a blank line; unexpected unindent. .../Documentation/hwmon/mp2975.rst:69: WARNING: Unexpected indentation. .../Documentation/hwmon/mp2975.rst:70: WARNING: Block quote ends without a blank line; unexpected unindent. .../Documentation/hwmon/mp2975.rst:72: WARNING: Bullet list ends without a blank line; unexpected unindent. .../Documentation/hwmon/mp2975.rst: WARNING: document isn't included in any toctree
List blocks should have blank lines before and after them, in order to be properly parsed.
--- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/mp2975.rst | 14 +++++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-)
Documentation/hwmon/index.rst +1 -0
@@ -132,6 +132,7 @@ Hardware Monitoring Kernel Drivers mcp3021 menf21bmc mlxreg-fan + mp2975 nct6683 nct6775 nct7802
Documentation/hwmon/mp2975.rst +13 -1
@@ -20,6 +20,7 @@ This driver implements support for Monolithic Power Systems, Inc. (MPS) vendor dual-loop, digital, multi-phase controller MP2975. This device: + - Supports up to two power rail. - Provides 8 pulse-width modulations (PWMs), and can be configured up to 8-phase operation for rail 1 and up to 4-phase operation for rail
@@ -32,10 +33,12 @@ This device: 10-mV DAC, IMVP9 mode with 5-mV DAC. Device supports: + - SVID interface. - AVSBus interface. Device complaint with: + - PMBus rev 1.3 interface. Device supports direct format for reading output current, output voltage,
@@ -45,11 +48,14 @@ Device supports VID and direct formats for reading output voltage. The below VID modes are supported: VR12, VR13, IMVP9. The driver provides the next attributes for the current: + - for current in: input, maximum alarm; - for current out input, maximum alarm and highest values; - for phase current: input and label. -attributes. + attributes. + The driver exports the following attributes via the 'sysfs' files, where + - 'n' is number of telemetry pages (from 1 to 2); - 'k' is number of configured phases (from 1 to 8); - indexes 1, 1*n for "iin";
@@ -65,11 +71,14 @@ The driver exports the following attributes via the 'sysfs' files, where **curr[1-{2n+k}]_label** The driver provides the next attributes for the voltage: + - for voltage in: input, high critical threshold, high critical alarm, all only from page 0; - for voltage out: input, low and high critical thresholds, low and high critical alarms, from pages 0 and 1; + The driver exports the following attributes via the 'sysfs' files, where + - 'n' is number of telemetry pages (from 1 to 2); - indexes 1 for "iin"; - indexes n+1, n+2 for "vout";
@@ -87,9 +96,12 @@ The driver exports the following attributes via the 'sysfs' files, where **in[2-{n+1}1_lcrit_alarm** The driver provides the next attributes for the power: + - for power in alarm and input. - for power out: highest and input. + The driver exports the following attributes via the 'sysfs' files, where + - 'n' is number of telemetry pages (from 1 to 2); - indexes 1 for "pin"; - indexes n+1, n+2 for "pout";
Signature · 1 line
2.26.2
PATCH v3 8/32 docs: userspace-api: add iommu.rst to the index file
In reply to Mauro Carvalho ChehabThere's a new uAPI doc for IOMMU. Add it to the index file. Should address this warning:
.../Documentation/userspace-api/iommu.rst: WARNING: document isn't included in any toctree
--- Documentation/userspace-api/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/userspace-api/index.rst +1 -0
@@ -22,6 +22,7 @@ place where this information is gathered. spec_ctrl accelerators/ocxl ioctl/index + iommu media/index .. only:: subproject and html
Signature · 1 line
2.26.2
PATCH v3 9/32 blk-mq: docs: add kernel-doc description for a new struct member
In reply to Mauro Carvalho ChehabAs reported by kernel-doc:
./include/linux/blk-mq.h:267: warning: Function parameter or member 'active_queues_shared_sbitmap' not described in 'blk_mq_tag_set'
There is now a new member for struct blk_mq_tag_set. Add a description for it, based on the commit that introduced it.
--- include/linux/blk-mq.h | 2 ++ 1 file changed, 2 insertions(+)
include/linux/blk-mq.h +2 -0
@@ -235,6 +235,8 @@ enum hctx_type {* @flags: Zero or more BLK_MQ_F_* flags. * @driver_data: Pointer to data owned by the block driver that created this * tag set. +* @active_queues_shared_sbitmap: +* number of active request queues per tag set. * @__bitmap_tags: A shared tags sbitmap, used over all hctx's * @__breserved_tags: * A shared reserved tags sbitmap, used over all hctx's
Signature · 1 line
2.26.2
PATCH v3 10/32 drm: kernel-doc: document drm_dp_set_subconnector_property() params
In reply to Mauro Carvalho ChehabChangeset e5b92773287c ("drm: report dp downstream port type as a subconnector property") added a new function to the kAPI, but didn't add any documentation
for the parameters for drm_dp_set_subconnector_property().
--- drivers/gpu/drm/drm_dp_helper.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/gpu/drm/drm_dp_helper.c +6 -1
@@ -1028,7 +1028,8 @@ EXPORT_SYMBOL(drm_dp_downstream_debug);/** * drm_dp_subconnector_type() - get DP branch device type -* +* @dpcd: DisplayPort configuration data +* @port_cap: port capabilities */ enum drm_mode_subconnector drm_dp_subconnector_type(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
@@ -1079,6 +1080,10 @@ EXPORT_SYMBOL(drm_dp_subconnector_type);/** * drm_mode_set_dp_subconnector_property - set subconnector for DP connector +* @connector: connector to set property on +* @status: connector status +* @dpcd: DisplayPort configuration data +* @port_cap: port capabilities * * Called by a driver on every detect event. */
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 11/32 drm/dp: fix kernel-doc warnings at drm_dp_helper.c
In reply to Mauro Carvalho ChehabAs warned by kernel-doc:
./drivers/gpu/drm/drm_dp_helper.c:385: warning: Function parameter or member 'type' not described in 'drm_dp_downstream_is_type' ./drivers/gpu/drm/drm_dp_helper.c:886: warning: Function parameter or member 'dev' not described in 'drm_dp_downstream_mode'
Some function parameters weren't documented.
--- drivers/gpu/drm/drm_dp_helper.c | 5 +++++ 1 file changed, 5 insertions(+)
drivers/gpu/drm/drm_dp_helper.c +5 -0
@@ -374,6 +374,10 @@ static bool is_edid_digital_input_dp(const struct edid *edid)* drm_dp_downstream_is_type() - is the downstream facing port of certain type? * @dpcd: DisplayPort configuration data * @port_cap: port capabilities +* @type: port type to be checked. Can be: +* %DP_DS_PORT_TYPE_DP, %DP_DS_PORT_TYPE_VGA, %DP_DS_PORT_TYPE_DVI, +* %DP_DS_PORT_TYPE_HDMI, %DP_DS_PORT_TYPE_NON_EDID, +* %DP_DS_PORT_TYPE_DP_DUALMODE or %DP_DS_PORT_TYPE_WIRELESS. * * Caveat: Only works with DPCD 1.1+ port caps. *
@@ -870,6 +874,7 @@ EXPORT_SYMBOL(drm_dp_downstream_444_to_420_conversion);/** * drm_dp_downstream_mode() - return a mode for downstream facing port +* @dev: DRM device * @dpcd: DisplayPort configuration data * @port_cap: port capabilities *
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 12/32 drm/dp: fix a kernel-doc issue at drm_edid.c
In reply to Mauro Carvalho ChehabThe name of the argument is different, causing those warnings:
./drivers/gpu/drm/drm_edid.c:3754: warning: Function parameter or member 'video_code' not described in 'drm_display_mode_from_cea_vic' ./drivers/gpu/drm/drm_edid.c:3754: warning: Excess function parameter 'vic' description in 'drm_display_mode_from_cea_vic'
--- drivers/gpu/drm/drm_edid.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_edid.c +1 -1
@@ -3741,7 +3741,7 @@ drm_add_cmdb_modes(struct drm_connector *connector, u8 svd)/** * drm_display_mode_from_cea_vic() - return a mode for CEA VIC * @dev: DRM device -* @vic: CEA VIC of the mode +* @video_code: CEA VIC of the mode * * Creates a new mode matching the specified CEA VIC. *
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 13/32 mm: pagemap.h: fix two kernel-doc markups
In reply to Mauro Carvalho ChehabChangeset a8cf7f272b5a ("mm: add find_lock_head") renamed the index parameter, but forgot to update the kernel-doc markups accordingly.
--- include/linux/pagemap.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
include/linux/pagemap.h +4 -4
@@ -344,9 +344,9 @@ static inline struct page *find_get_page_flags(struct address_space *mapping,/** * find_lock_page - locate, pin and lock a pagecache page * @mapping: the address_space to search -* @offset: the page index +* @index: the page index * -* Looks up the page cache entry at @mapping & @offset. If there is a +* Looks up the page cache entry at @mapping & @index. If there is a * page cache page, it is returned locked and with an increased * refcount. *
@@ -363,9 +363,9 @@ static inline struct page *find_lock_page(struct address_space *mapping,/** * find_lock_head - Locate, pin and lock a pagecache page. * @mapping: The address_space to search. -* @offset: The page index. +* @index: The page index. * -* Looks up the page cache entry at @mapping & @offset. If there is a +* Looks up the page cache entry at @mapping & @index. If there is a * page cache page, its head page is returned locked and with an increased * refcount. *
Signature · 1 line
2.26.2
PATCH v3 14/32 net: phy: remove kernel-doc duplication
In reply to Mauro Carvalho ChehabSphinx 3 now checks for duplicated function declarations:
.../Documentation/networking/kapi:143: ../include/linux/phy.h:163: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'unsigned int phy_supported_speeds (struct phy_device *phy, unsigned int *speeds, unsigned int size)'. .../Documentation/networking/kapi:143: ../include/linux/phy.h:1034: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'. .../Documentation/networking/kapi:143: ../include/linux/phy.h:1076: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int __phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'. .../Documentation/networking/kapi:143: ../include/linux/phy.h:1088: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'. .../Documentation/networking/kapi:143: ../include/linux/phy.h:1100: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int __phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'.
It turns that both the C and the H files have the same kernel-doc markup for the same functions. Let's drop the at the header file, keeping the one closer to the code.
--- include/linux/phy.h | 40 +++++----------------------------------- 1 file changed, 5 insertions(+), 35 deletions(-)
include/linux/phy.h +5 -35
@@ -147,16 +147,8 @@ typedef enum {PHY_INTERFACE_MODE_MAX , } phy_interface_t; -/** +/* * phy_supported_speeds - return all speeds currently supported by a PHY device -* @phy: The PHY device to return supported speeds of. -* @speeds: buffer to store supported speeds in. -* @size: size of speeds buffer. -* -* Description: Returns the number of supported speeds, and fills -* the speeds buffer with the supported speeds. If speeds buffer is -* too small to contain all currently supported speeds, will return as -* many speeds as can fit. */ unsigned int phy_supported_speeds(struct phy_device *phy, unsigned int *speeds,
@@ -1022,14 +1014,9 @@ static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum, regnum, mask, set); } -/** +/* * phy_read_mmd - Convenience function for reading a register * from an MMD on a given PHY. -* @phydev: The phy_device struct -* @devad: The MMD to read from -* @regnum: The register on the MMD to read -* -* Same rules as for phy_read(); */ int phy_read_mmd (struct phy_device *phydev,int devad,u32 regnum);
@@ -1064,38 +1051,21 @@ int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); __ret; \ }) -/** +/* * __phy_read_mmd - Convenience function for reading a register * from an MMD on a given PHY. -* @phydev: The phy_device struct -* @devad: The MMD to read from -* @regnum: The register on the MMD to read -* -* Same rules as for __phy_read(); */ int __phy_read_mmd (struct phy_device *phydev,int devad,u32 regnum); -/** +/* * phy_write_mmd - Convenience function for writing a register * on an MMD on a given PHY. -* @phydev: The phy_device struct -* @devad: The MMD to write to -* @regnum: The register on the MMD to read -* @val: value to write to @regnum -* -* Same rules as for phy_write(); */ int phy_write_mmd (struct phy_device *phydev,int devad,u32 regnum,u16 val); -/** +/* * __phy_write_mmd - Convenience function for writing a register * on an MMD on a given PHY. -* @phydev: The phy_device struct -* @devad: The MMD to write to -* @regnum: The register on the MMD to read -* @val: value to write to @regnum -* -* Same rules as for __phy_write(); */ int __phy_write_mmd (struct phy_device *phydev,int devad,u32 regnum,u16 val);
Signature · 1 line
2.26.2
Re: [PATCH v3 14/32] net: phy: remove kernel-doc duplication
Quoted 13 lines · Mauro Carvalho Chehab
Sphinx 3 now checks for duplicated function declarations:
.../Documentation/networking/kapi:143:
../include/linux/phy.h:163: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'unsigned intphy_supported_speeds(structphy_device*phy, unsigned int *speeds, unsigned int size)'. .../Documentation/networking/kapi:143:../include/linux/phy.h:1034: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'intphy_read_mmd(structphy_device*phydev, int devad, u32 regnum)'. .../Documentation/networking/kapi:143:../include/linux/phy.h:1076: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int__phy_read_mmd(structphy_device*phydev, int devad, u32 regnum)'. .../Documentation/networking/kapi:143:../include/linux/phy.h:1088: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'intphy_write_mmd(structphy_device*phydev, int devad, u32 regnum, u16 val)'. .../Documentation/networking/kapi:143:../include/linux/phy.h:1100: WARNING: Duplicate C declaration, also defined in 'networking/kapi'. Declaration is 'int__phy_write_mmd(structphy_device*phydev, int devad, u32 regnum, u16 val)'.
Quoted 5 lines
It turns that both the C and the H files have the same kernel-doc markup for the same functions. Let's drop the at the header file, keeping the one closer to the code.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Andrew
PATCH v3 15/32 crypto: sun8x-ce*: update entries to its documentation
In reply to Mauro Carvalho ChehabThe README file was converted to ReST format. Update the references for it accordingly.
--- drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c | 2 +- drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c | 2 +- drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c +1 -1
@@ -7,7 +7,7 @@* * This file add support for MD5 and SHA1/SHA224/SHA256/SHA384/SHA512. * -* You could find the datasheet in Documentation/arm/sunxi/README +* You could find the datasheet in Documentation/arm/sunxi.rst */ #include <linux/dma-mapping.h> #include <linux/pm_runtime.h>
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c +1 -1
@@ -7,7 +7,7 @@* * This file handle the PRNG * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include "sun8i-ce.h" #include <linux/dma-mapping.h>
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c +1 -1
@@ -7,7 +7,7 @@* * This file handle the TRNG * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include "sun8i-ce.h" #include <linux/dma-mapping.h>
Signature · 7 lines
2.26.2 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH v3 16/32 ice: docs fix a devlink info that broke a table
In reply to Mauro Carvalho ChehabChangeset 410d06879c01 ("ice: add the DDP Track ID to devlink info") added description for a new devlink field, but forgot to add one of its columns, causing it to break:
.../Documentation/networking/devlink/ice.rst:15: WARNING: Error parsing content block for the "list-table" directive: uniform two-level bullet list expected, but row 11 does not contain the same number of items as row 1 (3 vs 4).
.. list-table:: devlink info versions implemented
:widths: 5 5 5 90
...
* - ``fw.app.bundle_id``
- 0xc0000001
- Unique identifier for the DDP package loaded in the device. Also referred to as the DDP Track ID. Can be used to uniquely identify the specific DDP package.
Add the type field to the ``fw.app.bundle_id`` row.
--- Documentation/networking/devlink/ice.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/networking/devlink/ice.rst +1 -0
@@ -70,6 +70,7 @@ The ``ice`` driver reports the following versions that both the name (as reported by ``fw.app.name``) and version are required to uniquely identify the package. * - ``fw.app.bundle_id`` + - running - 0xc0000001 - Unique identifier for the DDP package loaded in the device. Also referred to as the DDP Track ID. Can be used to uniquely identify
Signature · 1 line
2.26.2
PATCH v3 17/32 MAINTAINERS: fix broken doc refs due to yaml conversion
In reply to Mauro Carvalho ChehabSeveral *.txt files got converted to yaml. Update their references at MAINTAINERS file accordingly.
--- Documentation/devicetree/bindings/clock/hi6220-clock.txt | 2 +- MAINTAINERS | 9 ++++----- .../devicetree/bindings/net/wireless/silabs,wfx.yaml | 2 +- 3 files changed, 6 insertions(+), 7 deletions(-)
Documentation/devicetree/bindings/clock/hi6220-clock.txt +1 -1
@@ -4,7 +4,7 @@ Clock control registers reside in different Hi6220 system controllers, please refer the following document to know more about the binding rules for these system controllers: -Documentation/devicetree/bindings/arm/hisilicon/hisilicon.txt +Documentation/devicetree/bindings/arm/hisilicon/hisilicon.yaml Required Properties:
MAINTAINERS +4 -5
@@ -978,7 +978,7 @@ M: Michael Hennerich <[email protected]> L: [email protected] S: Supported W: http://ez.analog.com/community/linux-device-drivers -F: Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt +F: Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml F: drivers/iio/adc/ad7768-1.c ANALOG DEVICES INC AD7780 DRIVER
@@ -3860,7 +3860,7 @@ M: Roger Quadros <[email protected]> L: [email protected] S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/peter.chen/usb.git -F: Documentation/devicetree/bindings/usb/cdns-usb3.txt +F: Documentation/devicetree/bindings/usb/cdns,usb3.yaml F: drivers/usb/cdns3/ CADET FM/AM RADIO RECEIVER DRIVER
@@ -7920,7 +7920,7 @@ HISILICON LPC BUS DRIVER M: [email protected] S: Maintained W: http://www.hisilicon.com -F: Documentation/devicetree/bindings/arm/hisilicon/hisilicon-low-pin-count.txt +F: Documentation/devicetree/bindings/arm/hisilicon/low-pin-count.yaml F: drivers/bus/hisi_lpc.c HISILICON NETWORK SUBSYSTEM 3 DRIVER (HNS3)
@@ -14902,7 +14902,6 @@ RENESAS ETHERNET DRIVERS R: Sergei Shtylyov <[email protected]> L: [email protected] L: [email protected] -F: Documentation/devicetree/bindings/net/renesas,*.txt F: Documentation/devicetree/bindings/net/renesas,*.yaml F: drivers/net/ethernet/renesas/ F: include/linux/sh_eth.h
@@ -18106,7 +18105,7 @@ M: Yu Chen <[email protected]> M: Binghui Wang <[email protected]> L: [email protected] S: Maintained -F: Documentation/devicetree/bindings/phy/phy-hi3660-usb3.txt +F: Documentation/devicetree/bindings/phy/hisilicon,hi3660-usb3.yaml F: drivers/phy/hisilicon/phy-hi3660-usb3.c USB ISP116X DRIVER
drivers/staging/wfx/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml +1 -1
@@ -24,7 +24,7 @@ description: In addition, it is recommended to declare a mmc-pwrseq on SDIO host above WFx. Without it, you may encounter issues with warm boot. The mmc-pwrseq should be compatible with mmc-pwrseq-simple. Please consult - Documentation/devicetree/bindings/mmc/mmc-pwrseq-simple.txt for more + Documentation/devicetree/bindings/mmc/mmc-pwrseq-simple.yaml for more information. For SPI':'
Signature · 1 line
2.26.2
PATCH v3 18/32 docs: lockdep-design: fix some warning issues
In reply to Mauro Carvalho ChehabThere are several warnings caused by a recent change224ec489d3cd ("lockdep/Documention: Recursive read lock detection reasoning")
Those are reported by htmldocs build:
Documentation/locking/lockdep-design.rst:429: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/locking/lockdep-design.rst:452: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/locking/lockdep-design.rst:453: WARNING: Unexpected indentation. Documentation/locking/lockdep-design.rst:453: WARNING: Blank line required after table. Documentation/locking/lockdep-design.rst:454: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/locking/lockdep-design.rst:455: WARNING: Unexpected indentation. Documentation/locking/lockdep-design.rst:455: WARNING: Blank line required after table. Documentation/locking/lockdep-design.rst:456: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/locking/lockdep-design.rst:457: WARNING: Unexpected indentation. Documentation/locking/lockdep-design.rst:457: WARNING: Blank line required after table.
Besides the reported issues, there are some missing blank lines that ended producing wrong html output, and some literals are not properly identified.
Also, the symbols used at the irq enabled/disable table are not displayed as expected, as they're not literals. Also, on another table they're using a different notation.
--- Documentation/locking/lockdep-design.rst | 51 ++++++++++++++---------- 1 file changed, 31 insertions(+), 20 deletions(-)
Documentation/locking/lockdep-design.rst +31 -20
@@ -42,6 +42,7 @@ The validator tracks lock-class usage history and divides the usage into (4 usages * n STATEs + 1) categories: where the 4 usages can be: + - 'ever held in STATE context' - 'ever held as readlock in STATE context' - 'ever held with STATE enabled'
@@ -49,10 +50,12 @@ where the 4 usages can be: where the n STATEs are coded in kernel/locking/lockdep_states.h and as of now they include: + - hardirq - softirq where the last 1 category is: + - 'ever used' [ == !unused ] When locking rules are violated, these usage bits are presented in the
@@ -96,9 +99,9 @@ exact case is for the lock as of the reporting time. +--------------+-------------+--------------+ | | irq enabled | irq disabled | +--------------+-------------+--------------+ - | ever in irq | ? | - | + | ever in irq | '?' | '-' | +--------------+-------------+--------------+ - | never in irq | + | . | + | never in irq | '+' | '.' | +--------------+-------------+--------------+ The character '-' suggests irq is disabled because if otherwise the
@@ -216,7 +219,7 @@ looks like this:: BD_MUTEX_PARTITION }; -mutex_lock_nested(&bdev->bd_contains->bd_mutex, BD_MUTEX_PARTITION); + mutex_lock_nested(&bdev->bd_contains->bd_mutex, BD_MUTEX_PARTITION); In this case the locking is done on a bdev object that is known to be a partition.
@@ -334,7 +337,7 @@ Troubleshooting: ---------------- The validator tracks a maximum of MAX_LOCKDEP_KEYS number of lock classes. -Exceeding this number will trigger the following lockdep warning: +Exceeding this number will trigger the following lockdep warning:: (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
@@ -420,7 +423,8 @@ the critical section of another reader of the same lock instance. The difference between recursive readers and non-recursive readers is because: recursive readers get blocked only by a write lock *holder*, while non-recursive -readers could get blocked by a write lock *waiter*. Considering the follow example: +readers could get blocked by a write lock *waiter*. Considering the follow +example:: TASK A: TASK B:
@@ -448,20 +452,22 @@ There are simply four block conditions: Block condition matrix, Y means the row blocks the column, and N means otherwise. - | E | r | R | +---+---+---+---+ - E | Y | Y | Y | + | | E | r | R | +---+---+---+---+ - r | Y | Y | N | + | E | Y | Y | Y | + +---+---+---+---+ + | r | Y | Y | N | + +---+---+---+---+ + | R | Y | Y | N | +---+---+---+---+ - R | Y | Y | N | (W: writers, r: non-recursive readers, R: recursive readers) acquired recursively. Unlike non-recursive read locks, recursive read locks only get blocked by current write lock *holders* other than write lock -*waiters*, for example: +*waiters*, for example:: TASK A: TASK B:
@@ -491,7 +497,7 @@ Recursive locks don't block each other, while non-recursive locks do (this is even true for two non-recursive read locks). A non-recursive lock can block the corresponding recursive lock, and vice versa. -A deadlock case with recursive locks involved is as follow: +A deadlock case with recursive locks involved is as follow:: TASK A: TASK B:
@@ -510,7 +516,7 @@ because there are 3 types for lockers, there are, in theory, 9 types of lock dependencies, but we can show that 4 types of lock dependencies are enough for deadlock detection. -For each lock dependency: +For each lock dependency:: L1 -> L2
@@ -525,20 +531,25 @@ same types). With the above combination for simplification, there are 4 types of dependency edges in the lockdep graph: -1) -(ER)->: exclusive writer to recursive reader dependency, "X -(ER)-> Y" means +1) -(ER)->: + exclusive writer to recursive reader dependency, "X -(ER)-> Y" means X -> Y and X is a writer and Y is a recursive reader. -2) -(EN)->: exclusive writer to non-recursive locker dependency, "X -(EN)-> Y" means +2) -(EN)->: + exclusive writer to non-recursive locker dependency, "X -(EN)-> Y" means X -> Y and X is a writer and Y is either a writer or non-recursive reader. -3) -(SR)->: shared reader to recursive reader dependency, "X -(SR)-> Y" means +3) -(SR)->: + shared reader to recursive reader dependency, "X -(SR)-> Y" means X -> Y and X is a reader (recursive or not) and Y is a recursive reader. -4) -(SN)->: shared reader to non-recursive locker dependency, "X -(SN)-> Y" means +4) -(SN)->: + shared reader to non-recursive locker dependency, "X -(SN)-> Y" means X -> Y and X is a reader (recursive or not) and Y is either a writer or non-recursive reader. -Note that given two locks, they may have multiple dependencies between them, for example: +Note that given two locks, they may have multiple dependencies between them, +for example:: TASK A:
@@ -592,11 +603,11 @@ circles that won't cause deadlocks. Proof for sufficiency (Lemma 1): -Let's say we have a strong circle: +Let's say we have a strong circle:: L1 -> L2 ... -> Ln -> L1 -, which means we have dependencies: +, which means we have dependencies:: L1 -> L2 L2 -> L3
@@ -633,7 +644,7 @@ a lock held by P2, and P2 is waiting for a lock held by P3, ... and Pn is waitin for a lock held by P1. Let's name the lock Px is waiting as Lx, so since P1 is waiting for L1 and holding Ln, so we will have Ln -> L1 in the dependency graph. Similarly, we have L1 -> L2, L2 -> L3, ..., Ln-1 -> Ln in the dependency graph, which means we -have a circle: +have a circle:: Ln -> L1 -> L2 -> ... -> Ln
Signature · 1 line
2.26.2
PATCH v3 19/32 locking/refcount: move kernel-doc markups to the proper place
In reply to Mauro Carvalho ChehabChangeset a435b9a14356 ("locking/refcount: Provide __refcount API to obtain the old value") added a set of functions starting with __ that have a new
parameter, adding a series of new warnings:
$ ./scripts/kernel-doc -none include/linux/refcount.h include/linux/refcount.h:169: warning: Function parameter or member 'oldp' not described in '__refcount_add_not_zero' include/linux/refcount.h:208: warning: Function parameter or member 'oldp' not described in '__refcount_add' include/linux/refcount.h:239: warning: Function parameter or member 'oldp' not described in '__refcount_inc_not_zero' include/linux/refcount.h:261: warning: Function parameter or member 'oldp' not described in '__refcount_inc' include/linux/refcount.h:291: warning: Function parameter or member 'oldp' not described in '__refcount_sub_and_test' include/linux/refcount.h:327: warning: Function parameter or member 'oldp' not described in '__refcount_dec_and_test' include/linux/refcount.h:347: warning: Function parameter or member 'oldp' not described in '__refcount_dec'
The issue is that the kernel-doc markups are now misplaced, as they should be added just before the functions.
So, move the kernel-doc markups to the proper places, in order to drop the warnings.
It should be noticed that git show produces a crappy output, for this patch without "--patience" flag.
--- include/linux/refcount.h | 158 +++++++++++++++++++-------------------- 1 file changed, 79 insertions(+), 79 deletions(-)
include/linux/refcount.h +79 -79
@@ -147,24 +147,6 @@ static inline unsigned int refcount_read(const refcount_t *r)return atomic_read (&r->refs); } -/** -* refcount_add_not_zero - add a value to a refcount unless it is 0 -* @i: the value to add to the refcount -* @r: the refcount -* -* Will saturate at REFCOUNT_SATURATED and WARN. -* -* Provides no memory ordering, it is assumed the caller has guaranteed the -* object memory to be stable (RCU, etc.). It does provide a control dependency -* and thereby orders future stores. See the comment on top. -* -* Use of this function is not recommended for the normal reference counting -* use case in which references are taken and released one at a time. In these -* cases, refcount_inc(), or one of its variants, should instead be used to -* increment a reference count. -* -* Return: false if the passed refcount is 0, true otherwise -*/ static inline __must_check bool __refcount_add_not_zero (int i,refcount_t *r,int *oldp) {int old =refcount_read (r);
@@ -183,27 +165,29 @@ static inline __must_check bool __refcount_add_not_zero(int i, refcount_t *r, inreturn old; } +/** +* refcount_add_not_zero - add a value to a refcount unless it is 0 +* @i: the value to add to the refcount +* @r: the refcount +* +* Will saturate at REFCOUNT_SATURATED and WARN. +* +* Provides no memory ordering, it is assumed the caller has guaranteed the +* object memory to be stable (RCU, etc.). It does provide a control dependency +* and thereby orders future stores. See the comment on top. +* +* Use of this function is not recommended for the normal reference counting +* use case in which references are taken and released one at a time. In these +* cases, refcount_inc(), or one of its variants, should instead be used to +* increment a reference count. +* +* Return: false if the passed refcount is 0, true otherwise +*/ static inline __must_check bool refcount_add_not_zero (int i,refcount_t *r) {return __refcount_add_not_zero (i, r,NULL ); } -/** -* refcount_add - add a value to a refcount -* @i: the value to add to the refcount -* @r: the refcount -* -* Similar to atomic_add(), but will saturate at REFCOUNT_SATURATED and WARN. -* -* Provides no memory ordering, it is assumed the caller has guaranteed the -* object memory to be stable (RCU, etc.). It does provide a control dependency -* and thereby orders future stores. See the comment on top. -* -* Use of this function is not recommended for the normal reference counting -* use case in which references are taken and released one at a time. In these -* cases, refcount_inc(), or one of its variants, should instead be used to -* increment a reference count. -*/ static inline void __refcount_add (int i,refcount_t *r,int *oldp) {int old =atomic_fetch_add_relaxed (i, &r->refs);
@@ -217,11 +201,32 @@ static inline void __refcount_add(int i, refcount_t *r, int *oldp)refcount_warn_saturate (r,REFCOUNT_ADD_OVF ); } +/** +* refcount_add - add a value to a refcount +* @i: the value to add to the refcount +* @r: the refcount +* +* Similar to atomic_add(), but will saturate at REFCOUNT_SATURATED and WARN. +* +* Provides no memory ordering, it is assumed the caller has guaranteed the +* object memory to be stable (RCU, etc.). It does provide a control dependency +* and thereby orders future stores. See the comment on top. +* +* Use of this function is not recommended for the normal reference counting +* use case in which references are taken and released one at a time. In these +* cases, refcount_inc(), or one of its variants, should instead be used to +* increment a reference count. +*/ static inline void refcount_add (int i,refcount_t *r) {__refcount_add (i, r,NULL ); } +static inline __must_check bool __refcount_inc_not_zero (refcount_t *r,int *oldp) +{ +return __refcount_add_not_zero (1 , r, oldp); +} +/** * refcount_inc_not_zero - increment a refcount unless it is 0 * @r: the refcount to increment
@@ -235,16 +240,16 @@ static inline void refcount_add(int i, refcount_t *r)* * Return: true if the increment was successful, false otherwise */ -static inline __must_check bool __refcount_inc_not_zero (refcount_t *r,int *oldp) -{ -return __refcount_add_not_zero (1 , r, oldp); -} -static inline __must_check bool refcount_inc_not_zero (refcount_t *r) {return __refcount_inc_not_zero (r,NULL ); } +static inline void __refcount_inc (refcount_t *r,int *oldp) +{ +__refcount_add (1 , r, oldp); +} +/** * refcount_inc - increment a refcount * @r: the refcount to increment
@@ -257,36 +262,11 @@ static inline __must_check bool refcount_inc_not_zero(refcount_t *r)* Will WARN if the refcount is 0, as this represents a possible use-after-free * condition. */ -static inline void __refcount_inc (refcount_t *r,int *oldp) -{ -__refcount_add (1 , r, oldp); -} -static inline void refcount_inc (refcount_t *r) {__refcount_inc (r,NULL ); } -/** -* refcount_sub_and_test - subtract from a refcount and test if it is 0 -* @i: amount to subtract from the refcount -* @r: the refcount -* -* Similar to atomic_dec_and_test(), but it will WARN, return false and -* ultimately leak on underflow and will fail to decrement when saturated -* at REFCOUNT_SATURATED. -* -* Provides release memory ordering, such that prior loads and stores are done -* before, and provides an acquire ordering on success such that free() -* must come after. -* -* Use of this function is not recommended for the normal reference counting -* use case in which references are taken and released one at a time. In these -* cases, refcount_dec(), or one of its variants, should instead be used to -* decrement a reference count. -* -* Return: true if the resulting refcount is 0, false otherwise -*/ static inline __must_check bool __refcount_sub_and_test (int i,refcount_t *r,int *oldp) {int old =atomic_fetch_sub_release (i, &r->refs);
@@ -305,11 +285,36 @@ static inline __must_check bool __refcount_sub_and_test(int i, refcount_t *r, inreturn false; } +/** +* refcount_sub_and_test - subtract from a refcount and test if it is 0 +* @i: amount to subtract from the refcount +* @r: the refcount +* +* Similar to atomic_dec_and_test(), but it will WARN, return false and +* ultimately leak on underflow and will fail to decrement when saturated +* at REFCOUNT_SATURATED. +* +* Provides release memory ordering, such that prior loads and stores are done +* before, and provides an acquire ordering on success such that free() +* must come after. +* +* Use of this function is not recommended for the normal reference counting +* use case in which references are taken and released one at a time. In these +* cases, refcount_dec(), or one of its variants, should instead be used to +* decrement a reference count. +* +* Return: true if the resulting refcount is 0, false otherwise +*/ static inline __must_check bool refcount_sub_and_test (int i,refcount_t *r) {return __refcount_sub_and_test (i, r,NULL ); } +static inline __must_check bool __refcount_dec_and_test (refcount_t *r,int *oldp) +{ +return __refcount_sub_and_test (1 , r, oldp); +} +/** * refcount_dec_and_test - decrement a refcount and test if it is 0 * @r: the refcount
@@ -323,26 +328,11 @@ static inline __must_check bool refcount_sub_and_test(int i, refcount_t *r)* * Return: true if the resulting refcount is 0, false otherwise */ -static inline __must_check bool __refcount_dec_and_test (refcount_t *r,int *oldp) -{ -return __refcount_sub_and_test (1 , r, oldp); -} -static inline __must_check bool refcount_dec_and_test (refcount_t *r) {return __refcount_dec_and_test (r,NULL ); } -/** -* refcount_dec - decrement a refcount -* @r: the refcount -* -* Similar to atomic_dec(), it will WARN on underflow and fail to decrement -* when saturated at REFCOUNT_SATURATED. -* -* Provides release memory ordering, such that prior loads and stores are done -* before. -*/ static inline void __refcount_dec (refcount_t *r,int *oldp) {int old =atomic_fetch_sub_release (1 , &r->refs);
@@ -354,6 +344,16 @@ static inline void __refcount_dec(refcount_t *r, int *oldp)refcount_warn_saturate (r,REFCOUNT_DEC_LEAK ); } +/** +* refcount_dec - decrement a refcount +* @r: the refcount +* +* Similar to atomic_dec(), it will WARN on underflow and fail to decrement +* when saturated at REFCOUNT_SATURATED. +* +* Provides release memory ordering, such that prior loads and stores are done +* before. +*/ static inline void refcount_dec (refcount_t *r) {__refcount_dec (r,NULL );
Signature · 1 line
2.26.2
PATCH v3 20/32 IB/srpt: docs: add a description for cq_size member
In reply to Mauro Carvalho ChehabChangeset c804af2c1d31 ("IB/srpt: use new shared CQ mechanism") added a new member for struct srpt_rdma_ch, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
./drivers/infiniband/ulp/srpt/ib_srpt.h:331: warning: Function parameter or member 'cq_size' not described in 'srpt_rdma_ch'
Add a description for it.
--- drivers/infiniband/ulp/srpt/ib_srpt.h | 1 + 1 file changed, 1 insertion(+)
drivers/infiniband/ulp/srpt/ib_srpt.h +1 -0
@@ -256,6 +256,7 @@ enum rdma_ch_state {* @rdma_cm: See below. * @rdma_cm.cm_id: RDMA CM ID associated with the channel. * @cq: IB completion queue for this channel. +* @cq_size: Number of CQEs in @cq. * @zw_cqe: Zero-length write CQE. * @rcu: RCU head. * @kref: kref for this channel.
Signature · 1 line
2.26.2
Bart Van Assche
maintainerRe: [PATCH v3 20/32] IB/srpt: docs: add a description for cq_size member
Quoted 1 line · Mauro Carvalho Chehab
Add a description for it.
It seems like my Reviewed-by tag is missing? See also
https://lore.kernel.org/linux-rdma/[email protected]/
Bart.
PATCH v3 21/32 docs: fs: api-summary.rst: get rid of kernel-doc include
In reply to Mauro Carvalho ChehabThe direct-io.c file used to have just two exported symbols:
- dio_end_io()
- __blockdev_direct_IO()
The first one was removed by changeset c33fe275b530 ("fs: remove no longer used dio_end_io()")
And the last one is used on most places indirectly, via the inline macro blockdev_direct_IO() provided by fs.h. Yet, neither the macro or the function have kernel-doc markups.
So, drop the inclusion of fs/direct-io.c at the docs.
--- Documentation/filesystems/api-summary.rst | 3 --- 1 file changed, 3 deletions(-)
Documentation/filesystems/api-summary.rst +0 -3
@@ -86,9 +86,6 @@ Other Functions .. kernel-doc:: fs/dax.c :export: -.. kernel-doc:: fs/direct-io.c - :export: - .. kernel-doc:: fs/libfs.c :export:
Signature · 1 line
2.26.2
PATCH v3 22/32 drm: amdgpu: kernel-doc: update some adev parameters
In reply to Mauro Carvalho ChehabRunning "make htmldocs: produce lots of warnings on those files:
./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'p_size' description in 'amdgpu_gtt_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:134: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'p_size' description in 'amdgpu_gtt_mgr_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:134: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_fini' ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init' ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init'
They're related to the repacement of some parameters by adev, and due to a few renamed parameters.
While here, uniform the name of the parameter for it to be the same on all functions using a pointer to struct amdgpu_device.
Update the kernel-doc documentation accordingly.
--- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 28 ++++++++++---------- drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c | 6 ++--- drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c | 7 +++-- 3 files changed, 20 insertions(+), 21 deletions(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +14 -14
@@ -705,7 +705,7 @@ void amdgpu_device_indirect_wreg64(struct amdgpu_device *adev,/** * amdgpu_invalid_rreg - dummy reg read function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @reg: offset of register * * Dummy register read function. Used for register blocks
@@ -722,7 +722,7 @@ static uint32_t amdgpu_invalid_rreg(struct amdgpu_device *adev, uint32_t reg)/** * amdgpu_invalid_wreg - dummy reg write function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @reg: offset of register * @v: value to write to the register *
@@ -739,7 +739,7 @@ static void amdgpu_invalid_wreg(struct amdgpu_device *adev, uint32_t reg, uint32/** * amdgpu_invalid_rreg64 - dummy 64 bit reg read function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @reg: offset of register * * Dummy register read function. Used for register blocks
@@ -756,7 +756,7 @@ static uint64_t amdgpu_invalid_rreg64(struct amdgpu_device *adev, uint32_t reg)/** * amdgpu_invalid_wreg64 - dummy reg write function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @reg: offset of register * @v: value to write to the register *
@@ -773,7 +773,7 @@ static void amdgpu_invalid_wreg64(struct amdgpu_device *adev, uint32_t reg, uint/** * amdgpu_block_invalid_rreg - dummy reg read function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @block: offset of instance * @reg: offset of register *
@@ -793,7 +793,7 @@ static uint32_t amdgpu_block_invalid_rreg(struct amdgpu_device *adev,/** * amdgpu_block_invalid_wreg - dummy reg write function * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @block: offset of instance * @reg: offset of register * @v: value to write to the register
@@ -813,7 +813,7 @@ static void amdgpu_block_invalid_wreg(struct amdgpu_device *adev,/** * amdgpu_device_asic_init - Wrapper for atom asic_init * -* @dev: drm_device pointer +* @adev: amdgpu_device pointer * * Does any asic specific work and then calls atom asic init. */
@@ -827,7 +827,7 @@ static int amdgpu_device_asic_init(struct amdgpu_device *adev)/** * amdgpu_device_vram_scratch_init - allocate the VRAM scratch page * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * * Allocates a scratch page of VRAM for use by various things in the * driver.
@@ -844,7 +844,7 @@ static int amdgpu_device_vram_scratch_init(struct amdgpu_device *adev)/** * amdgpu_device_vram_scratch_fini - Free the VRAM scratch page * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * * Frees the VRAM scratch page. */
@@ -3011,7 +3011,7 @@ bool amdgpu_device_asic_has_dc_support(enum amd_asic_type asic_type)/** * amdgpu_device_has_dc_support - check if dc is supported * -* @adev: amdgpu_device_pointer +* @adev: amdgpu_device pointer * * Returns true for supported, false for not supported */
@@ -4045,7 +4045,7 @@ static int amdgpu_device_recover_vram(struct amdgpu_device *adev)/** * amdgpu_device_reset_sriov - reset ASIC for SR-IOV vf * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @from_hypervisor: request from hypervisor * * do VF FLR and reinitialize Asic
@@ -4100,7 +4100,7 @@ static int amdgpu_device_reset_sriov(struct amdgpu_device *adev,/** * amdgpu_device_has_job_running - check if there is any job in mirror list * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * * check if there is any job in mirror list */
@@ -4128,7 +4128,7 @@ bool amdgpu_device_has_job_running(struct amdgpu_device *adev)/** * amdgpu_device_should_recover_gpu - check if we should try GPU recovery * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * * Check amdgpu_gpu_recovery and SRIOV status to see if we should try to recover * a hung GPU.
@@ -4477,7 +4477,7 @@ static int amdgpu_device_suspend_display_audio(struct amdgpu_device *adev)/** * amdgpu_device_gpu_recover - reset the asic and recover scheduler * -* @adev: amdgpu device pointer +* @adev: amdgpu_device pointer * @job: which job trigger hang * * Attempt to reset the GPU if it has hung (all asics).
drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c +3 -3
@@ -81,8 +81,8 @@ static const struct ttm_resource_manager_func amdgpu_gtt_mgr_func;/** * amdgpu_gtt_mgr_init - init GTT manager and DRM MM * -* @man: TTM memory type manager -* @p_size: maximum size of GTT +* @adev: amdgpu_device pointer +* @gtt_size: maximum size of GTT * * Allocate and initialize the GTT manager. */
@@ -123,7 +123,7 @@ int amdgpu_gtt_mgr_init(struct amdgpu_device *adev, uint64_t gtt_size)/** * amdgpu_gtt_mgr_fini - free and destroy GTT manager * -* @man: TTM memory type manager +* @adev: amdgpu_device pointer * * Destroy and free the GTT manager, returns -EBUSY if ranges are still * allocated inside it.
drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c +3 -4
@@ -168,8 +168,7 @@ static const struct ttm_resource_manager_func amdgpu_vram_mgr_func;/** * amdgpu_vram_mgr_init - init VRAM manager and DRM MM * -* @man: TTM memory type manager -* @p_size: maximum size of VRAM +* @adev: amdgpu_device pointer * * Allocate and initialize the VRAM manager. */
@@ -199,7 +198,7 @@ int amdgpu_vram_mgr_init(struct amdgpu_device *adev)/** * amdgpu_vram_mgr_fini - free and destroy VRAM manager * -* @man: TTM memory type manager +* @adev: amdgpu_device pointer * * Destroy and free the VRAM manager, returns -EBUSY if ranges are still * allocated inside it.
@@ -229,7 +228,7 @@ void amdgpu_vram_mgr_fini(struct amdgpu_device *adev)/** * amdgpu_vram_mgr_vis_size - Calculate visible node size * -* @adev: amdgpu device structure +* @adev: amdgpu_device pointer * @node: MM node structure * * Calculate how many bytes of the MM node are inside visible VRAM
Signature · 6 lines
2.26.2 _______________________________________________ amd-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/amd-gfx
PATCH v3 23/32 jbd2: fix a kernel-doc markup
In reply to Mauro Carvalho ChehabThe kernel-doc markup that documents _fc_replay_callback is missing an asterisk, causing this warning:
../include/linux/jbd2.h:1271: warning: Function parameter or member 'j_fc_replay_callback' not described in 'journal_s'
When building the docs.
--- include/linux/jbd2.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/jbd2.h +1 -1
@@ -1253,7 +1253,7 @@ struct journal_s*/ void (*j_fc_cleanup_callback)(struct journal_s *journal,int ); -/* +/** * @j_fc_replay_callback: * * File-system specific function that performs replay of a fast
Signature · 1 line
2.26.2
Theodore Y. Ts'o
maintainerRe: [PATCH v3 23/32] jbd2: fix a kernel-doc markup
Quoted 9 lines · Mauro Carvalho Chehab
The kernel-doc markup that documents
_fc_replay_callbackis missing an asterisk, causing this warning:
../include/linux/jbd2.h:1271: warning: Function parameter or member 'j_fc_replay_callback' not described in 'journal_s'When building the docs.
Fixes 609f928af48f ("jbd2: fast commit recovery path")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks, I'm accomulating some bug fix patches to push to Linus, so I'll grab this for the ext4 git tree.
- Ted
PATCH v3 24/32 drm: drm_edid: remove a duplicated kernel-doc declaration
In reply to Mauro Carvalho ChehabIt is not possible to create cross-references for duplicated symbols. While Sphinx always detected it, on Sphinx 3 it generates warnings like this:
.../Documentation/gpu/drm-kms-helpers:326: ../drivers/gpu/drm/drm_edid.c:1626: WARNING: Duplicate C declaration, also defined in 'gpu/drm-kms-helpers'. Declaration is 'bool drm_edid_are_equal (const struct edid *edid1, const struct edid *edid2)'.
So, get rid of the duplicated kernel-doc markup.
--- include/drm/drm_edid.h | 7 ------- 1 file changed, 7 deletions(-)
include/drm/drm_edid.h +0 -7
@@ -359,13 +359,6 @@ drm_load_edid_firmware(struct drm_connector *connector) }#endif -/** -* drm_edid_are_equal - compare two edid blobs. -* @edid1: pointer to first blob -* @edid2: pointer to second blob -* This helper can be used during probing to determine if -* edid had changed. -*/ bool drm_edid_are_equal (const struct edid *edid1,const struct edid *edid2);int
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 25/32 drm: kernel-doc: add description for a new function parameter
In reply to Mauro Carvalho ChehabAs reported by "make htmldocs":
./drivers/gpu/drm/drm_prime.c:808: warning: Function parameter or member 'dev' not described in 'drm_prime_pages_to_sg'
Add a description for the new parameter.
--- drivers/gpu/drm/drm_prime.c | 1 + 1 file changed, 1 insertion(+)
drivers/gpu/drm/drm_prime.c +1 -0
@@ -794,6 +794,7 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {/** * drm_prime_pages_to_sg - converts a page array into an sg list +* @dev: DRM device * @pages: pointer to the array of page pointers to convert * @nr_pages: length of the page vector *
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH v3 25/32] drm: kernel-doc: add description for a new function parameter
Quoted 8 lines · Mauro Carvalho Chehab
As reported by "make htmldocs":
./drivers/gpu/drm/drm_prime.c:808: warning: Function parameter or member 'dev' not described in 'drm_prime_pages_to_sg'Add a description for the new parameter.
Fixes 707d561f77b5 ("drm: allow limiting the scatter list size.")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 19 lines
--- drivers/gpu/drm/drm_prime.c | 1 + 1 file changed, 1 insertion(+)drivers/gpu/drm/drm_prime.c +1
-0@@ -794,6 +794,7 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {/** * drm_prime_pages_to_sg - converts a page array into an sg list +* @dev: DRM device * @pages: pointer to the array of page pointers to convert * @nr_pages: length of the page vector * Signature · 1 line
2.26.2
PATCH v3 26/32 gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups
In reply to Mauro Carvalho ChehabAs reported by kernel-doc:
./drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found ./drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found
Those files only contain
/** * DOC: */
markups, but they're included twice there: one to parse such markup, and another one to parse internal functions.
In the case of amdgpu_xgmi.c, as it has just one such markup, we can simply include the file once, and let it parse the entire file without passing arguments to kernel-doc.
This should place everything altogether.
For amdgpu_ras.c, however, we need to remove the kernel-doc with just internal. This should be re-introduced if this file ever gets new non-DOC markups.
--- Documentation/gpu/amdgpu.rst | 7 ------- 1 file changed, 7 deletions(-)
Documentation/gpu/amdgpu.rst +0 -7
@@ -83,10 +83,6 @@ AMDGPU XGMI Support =================== .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c - :doc: AMDGPU XGMI Support - -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c - :internal: AMDGPU RAS Support ==================
@@ -124,9 +120,6 @@ RAS VRAM Bad Pages sysfs Interface .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c :doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c - :internal: - Sample Code ----------- Sample code for testing error injection can be found here:
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 27/32 drm: kernel-doc: drm_dp_helper.h: fix a typo
In reply to Mauro Carvalho ChehabRight now, kernel-doc generates a warning:
./include/drm/drm_dp_helper.h:1786: warning: Function parameter or member 'hbr2_reset' not described in 'drm_dp_phy_test_params'
This is due to a typo:
@hb2_reset -> @hbr2_reset
--- include/drm/drm_dp_helper.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/drm/drm_dp_helper.h +1 -1
@@ -1836,7 +1836,7 @@ static inline void drm_dp_cec_unset_edid(struct drm_dp_aux *aux)* @link_rate: Requested Link rate from DPCD 0x219 * @num_lanes: Number of lanes requested by sing through DPCD 0x220 * @phy_pattern: DP Phy test pattern from DPCD 0x248 -* @hb2_reset: DP HBR2_COMPLIANCE_SCRAMBLER_RESET from DCPD 0x24A and 0x24B +* @hbr2_reset: DP HBR2_COMPLIANCE_SCRAMBLER_RESET from DCPD 0x24A and 0x24B * @custom80: DP Test_80BIT_CUSTOM_PATTERN from DPCDs 0x250 through 0x259 * @enhanced_frame_cap: flag for enhanced frame capability. */
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 28/32 drm: amdgpu_dm: fix a typo
In reply to Mauro Carvalho Chehabdm_comressor_info -> dm_compressor_info
The kernel-doc markup is right, but the struct itself and their references contain a typo.
--- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 2 +- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c +1 -1
@@ -583,7 +583,7 @@ static void amdgpu_dm_fbc_init(struct drm_connector *connector) {struct drm_device *dev = connector->dev;struct amdgpu_device *adev =drm_to_adev (dev); -struct dm_comressor_info *compressor = &adev->dm.compressor; +struct dm_compressor_info *compressor = &adev->dm.compressor;struct amdgpu_dm_connector *aconn =to_amdgpu_dm_connector (connector);struct drm_display_mode *mode;unsigned long max_size =0 ;
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +3 -3
@@ -86,7 +86,7 @@ struct irq_list_head {* @bo_ptr: Pointer to the buffer object * @gpu_addr: MMIO gpu addr */ -struct dm_comressor_info { +struct dm_compressor_info {void *cpu_addr;struct amdgpu_bo *bo_ptr;uint64_t gpu_addr;
@@ -148,7 +148,7 @@ struct amdgpu_dm_backlight_caps {* @soc_bounding_box: SOC bounding box values provided by gpu_info FW * @cached_state: Caches device atomic state for suspend/resume * @cached_dc_state: Cached state of content streams -* @compressor: Frame buffer compression buffer. See &struct dm_comressor_info +* @compressor: Frame buffer compression buffer. See &struct dm_compressor_info * @force_timing_sync: set via debugfs. When set, indicates that all connected * displays will be forced to synchronize. */
@@ -324,7 +324,7 @@ struct amdgpu_display_manager {struct drm_atomic_state *cached_state;struct dc_state *cached_dc_state; -struct dm_comressor_info compressor; +struct dm_compressor_info compressor;const struct firmware *fw_dmcu;uint32_t dmcu_fw_version;
Signature · 6 lines
2.26.2 _______________________________________________ amd-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/amd-gfx
PATCH v3 29/32 selftests: kselftest_harness.h: fix kernel-doc markups
In reply to Mauro Carvalho ChehabThe kernel-doc markups there is violating the expected syntax, causing it to not parse the name of the markup identifier properly, preventing it to check if the kernel-doc matches the #define below each markup.
--- tools/testing/selftests/kselftest_harness.h | 44 ++++++++++----------- 1 file changed, 22 insertions(+), 22 deletions(-)
tools/testing/selftests/kselftest_harness.h +22 -22
@@ -432,7 +432,7 @@*/ /** -* ASSERT_EQ(expected, seen) +* ASSERT_EQ() * * @expected: expected value * @seen: measured value
@@ -443,7 +443,7 @@ __EXPECT(expected, #expected, seen, #seen, ==, 1)/** -* ASSERT_NE(expected, seen) +* ASSERT_NE() * * @expected: expected value * @seen: measured value
@@ -454,7 +454,7 @@ __EXPECT(expected, #expected, seen, #seen, !=, 1)/** -* ASSERT_LT(expected, seen) +* ASSERT_LT() * * @expected: expected value * @seen: measured value
@@ -465,7 +465,7 @@ __EXPECT(expected, #expected, seen, #seen, <, 1)/** -* ASSERT_LE(expected, seen) +* ASSERT_LE() * * @expected: expected value * @seen: measured value
@@ -476,7 +476,7 @@ __EXPECT(expected, #expected, seen, #seen, <=, 1)/** -* ASSERT_GT(expected, seen) +* ASSERT_GT() * * @expected: expected value * @seen: measured value
@@ -487,7 +487,7 @@ __EXPECT(expected, #expected, seen, #seen, >, 1)/** -* ASSERT_GE(expected, seen) +* ASSERT_GE() * * @expected: expected value * @seen: measured value
@@ -498,7 +498,7 @@ __EXPECT(expected, #expected, seen, #seen, >=, 1)/** -* ASSERT_NULL(seen) +* ASSERT_NULL() * * @seen: measured value *
@@ -508,7 +508,7 @@ __EXPECT(NULL, "NULL", seen, #seen, ==, 1)/** -* ASSERT_TRUE(seen) +* ASSERT_TRUE() * * @seen: measured value *
@@ -518,7 +518,7 @@ __EXPECT(0, "0", seen, #seen, !=, 1)/** -* ASSERT_FALSE(seen) +* ASSERT_FALSE() * * @seen: measured value *
@@ -528,7 +528,7 @@ __EXPECT(0, "0", seen, #seen, ==, 1)/** -* ASSERT_STREQ(expected, seen) +* ASSERT_STREQ() * * @expected: expected value * @seen: measured value
@@ -539,7 +539,7 @@ __EXPECT_STR(expected, seen, ==, 1)/** -* ASSERT_STRNE(expected, seen) +* ASSERT_STRNE() * * @expected: expected value * @seen: measured value
@@ -550,7 +550,7 @@ __EXPECT_STR(expected, seen, !=, 1)/** -* EXPECT_EQ(expected, seen) +* EXPECT_EQ() * * @expected: expected value * @seen: measured value
@@ -561,7 +561,7 @@ __EXPECT(expected, #expected, seen, #seen, ==, 0)/** -* EXPECT_NE(expected, seen) +* EXPECT_NE() * * @expected: expected value * @seen: measured value
@@ -572,7 +572,7 @@ __EXPECT(expected, #expected, seen, #seen, !=, 0)/** -* EXPECT_LT(expected, seen) +* EXPECT_LT() * * @expected: expected value * @seen: measured value
@@ -583,7 +583,7 @@ __EXPECT(expected, #expected, seen, #seen, <, 0)/** -* EXPECT_LE(expected, seen) +* EXPECT_LE() * * @expected: expected value * @seen: measured value
@@ -594,7 +594,7 @@ __EXPECT(expected, #expected, seen, #seen, <=, 0)/** -* EXPECT_GT(expected, seen) +* EXPECT_GT() * * @expected: expected value * @seen: measured value
@@ -605,7 +605,7 @@ __EXPECT(expected, #expected, seen, #seen, >, 0)/** -* EXPECT_GE(expected, seen) +* EXPECT_GE() * * @expected: expected value * @seen: measured value
@@ -616,7 +616,7 @@ __EXPECT(expected, #expected, seen, #seen, >=, 0)/** -* EXPECT_NULL(seen) +* EXPECT_NULL() * * @seen: measured value *
@@ -626,7 +626,7 @@ __EXPECT(NULL, "NULL", seen, #seen, ==, 0)/** -* EXPECT_TRUE(seen) +* EXPECT_TRUE() * * @seen: measured value *
@@ -636,7 +636,7 @@ __EXPECT(0, "0", seen, #seen, !=, 0)/** -* EXPECT_FALSE(seen) +* EXPECT_FALSE() * * @seen: measured value *
@@ -646,7 +646,7 @@ __EXPECT(0, "0", seen, #seen, ==, 0)/** -* EXPECT_STREQ(expected, seen) +* EXPECT_STREQ() * * @expected: expected value * @seen: measured value
@@ -657,7 +657,7 @@ __EXPECT_STR(expected, seen, ==, 0)/** -* EXPECT_STRNE(expected, seen) +* EXPECT_STRNE() * * @expected: expected value * @seen: measured value
Signature · 1 line
2.26.2
PATCH v3 30/32 amdgpu: fix a few kernel-doc markup issues
In reply to Mauro Carvalho ChehabA kernel-doc markup can't be mixed with a random comment, as it causes parsing problems.
While here, change an invalid kernel-doc markup into a common comment.
--- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +5 -3
@@ -239,9 +239,11 @@ bool amdgpu_device_supports_baco(struct drm_device *dev)return amdgpu_asic_supports_baco (adev); } +/* +* VRAM access helper functions +*/ +/** -* VRAM access helper functions. -* * amdgpu_device_vram_access - read/write a buffer in vram * * @adev: amdgpu_device pointer
@@ -4497,7 +4499,7 @@ int amdgpu_device_gpu_recover(struct amdgpu_device *adev,bool need_emergency_restart = false;bool audio_suspended = false; -/** +/* * Special case: RAS triggered and full reset isn't supported */ need_emergency_restart =amdgpu_ras_need_emergency_restart (adev);
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 31/32 drm: drm_print.h: fix kernel-doc markups
In reply to Mauro Carvalho ChehabA kernel-doc markup should start with the identifier on its first line.
--- include/drm/drm_print.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-)
include/drm/drm_print.h +17 -3
@@ -338,7 +338,7 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, const char *format, ...);/** -* Error output. +* DRM_DEV_ERROR() - Error output. * * @dev: device pointer * @fmt: printf() like format string.
@@ -347,10 +347,12 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)/** -* Rate limited error output. Like DRM_ERROR() but won't flood the log. +* DRM_DEV_ERROR_RATELIMITED() - Rate limited error output. * * @dev: device pointer * @fmt: printf() like format string. +* +* Like DRM_ERROR() but won't flood the log. */#define DRM_DEV_ERROR_RATELIMITED (dev, fmt, ...) \ ({ \
@@ -375,15 +377,27 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, })/** -* Debug output. +* DRM_DEV_DEBUG() - Debug output for generic drm code * * @dev: device pointer * @fmt: printf() like format string. */ #define DRM_DEV_DEBUG (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__) +/** +* DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver +* +* @dev: device pointer +* @fmt: printf() like format string. +*/ #define DRM_DEV_DEBUG_DRIVER (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__) +/** +* DRM_DEV_DEBUG_KMS() - Debug output for modesetting code +* +* @dev: device pointer +* @fmt: printf() like format string. +*/ #define DRM_DEV_DEBUG_KMS (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH v3 31/32] drm: drm_print.h: fix kernel-doc markups
Quoted 4 lines · Mauro Carvalho Chehab
A kernel-doc markup should start with the identifier on its first line.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
I've merged all the drm patches, excluding the amdgpu ones, to drm-misc-fixes. Should land in -rc2.
Thanks for doing these patches.
-Daniel
Quoted 63 lines
--- include/drm/drm_print.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-)include/drm/drm_print.h +17
-3@@ -338,7 +338,7 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, const char *format, ...);/** -* Error output. +* DRM_DEV_ERROR() - Error output. * * @dev: device pointer * @fmt: printf() like format string. @@ -347,10 +347,12 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)/** -* Rate limited error output. Like DRM_ERROR() but won't flood the log. +* DRM_DEV_ERROR_RATELIMITED() - Rate limited error output. * * @dev: device pointer * @fmt: printf() like format string. +* +* Like DRM_ERROR() but won't flood the log. */#define DRM_DEV_ERROR_RATELIMITED (dev, fmt, ...) \ ({ \@@ -375,15 +377,27 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, })/** -* Debug output. +* DRM_DEV_DEBUG() - Debug output for generic drm code * * @dev: device pointer * @fmt: printf() like format string. */ #define DRM_DEV_DEBUG (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__) +/** +* DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver +* +* @dev: device pointer +* @fmt: printf() like format string. +*/ #define DRM_DEV_DEBUG_DRIVER (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__) +/** +* DRM_DEV_DEBUG_KMS() - Debug output for modesetting code +* +* @dev: device pointer +* @fmt: printf() like format string. +*/ #define DRM_DEV_DEBUG_KMS (dev, fmt, ...) \ drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)Signature · 1 line
2.26.2
Signature · 7 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v3 32/32 docs: SafeSetID: fix a warning
In reply to Mauro Carvalho ChehabAs reported by Sphinx 2.4.4:
docs/Documentation/admin-guide/LSM/SafeSetID.rst:110: WARNING: Title underline too short.
Note on GID policies and setgroups()
==================
--- Documentation/admin-guide/LSM/SafeSetID.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/LSM/SafeSetID.rst +1 -1
@@ -107,7 +107,7 @@ for a UID/GID will prevent that UID/GID from obtaining auxiliary setid privileges, such as allowing a user to set up user namespace UID/GID mappings. Note on GID policies and setgroups() -================== +==================================== In v5.9 we are adding support for limiting CAP_SETGID privileges as was done previously for CAP_SETUID. However, for compatibility with common sandboxing related code conventions in userspace, we currently allow arbitrary
Signature · 1 line
2.26.2
Jonathan Corbet
maintainerQuoted 16 lines · On Tue, 27 Oct 2020 10:51:04 +0100 Mauro Carvalho Chehab…
This series contain the patches from a previous series I sent:
[PATCH v2 00/24] Documentation build fixes against next-20201013Plus other patches I sent later, against other versions of linux-next between 20201013 and v5.10-rc1.
It fixes most of the remaining documentation build warnings.
There were some changes from v2, as I changed some patches due to the feedback received, and added reviewed-by/acked-by to several of them.
After this series, there will be just 3 warnings at
include/kunit/test.h, whose fixes were already applied by Shuah via her tree at linux-next. Hopefully, she will be sending it upstream anytime toon. So, I dropped the fix from my trees.
Quoted 6 lines
The vast majority of patches here are also on my linux-next tree, as my original plan were to send them upstream by the end of the merge window. I'll drop from it once they get merged.
As those patches are fixes, I guess it should be ok to get them merged for -rc2 or -rc3.
I have tentatively applied these, minus the DRM/JBD patches that have been picked up elsewhere. If all looks good, I'll push them up in the not-too-distant future.
Thanks,
jon