diff options
| author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
| commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
| tree | 2fea02768d6005934547f075586c60ba7aca6253 /drivers/pci | |
| parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
| download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz | |
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'drivers/pci')
| -rw-r--r-- | drivers/pci/pci-uclass.c | 6 | ||||
| -rw-r--r-- | drivers/pci/pci_common.c | 2 | ||||
| -rw-r--r-- | drivers/pci/pci_internal.h | 4 | ||||
| -rw-r--r-- | drivers/pci/pci_rom.c | 2 |
4 files changed, 7 insertions, 7 deletions
diff --git a/drivers/pci/pci-uclass.c b/drivers/pci/pci-uclass.c index 5da3515f5f..c66cd756d9 100644 --- a/drivers/pci/pci-uclass.c +++ b/drivers/pci/pci-uclass.c @@ -76,7 +76,7 @@ pci_dev_t dm_pci_get_bdf(const struct udevice *dev) /** * pci_get_bus_max() - returns the bus number of the last active bus * - * @return last bus number, or -1 if no active buses + * Return: last bus number, or -1 if no active buses */ static int pci_get_bus_max(void) { @@ -700,7 +700,7 @@ static bool pci_match_one_id(const struct pci_device_id *id, * @bus: Bus to check * @vendor: Vendor ID to check * @device: Device ID to check - * @return true if the vendor/device is in the list, false if not + * Return: true if the vendor/device is in the list, false if not */ static bool pci_need_device_pre_reloc(struct udevice *bus, uint vendor, uint device) @@ -728,7 +728,7 @@ static bool pci_need_device_pre_reloc(struct udevice *bus, uint vendor, * @find_id: Specification of the driver to find * @bdf: Bus/device/function addreess - see PCI_BDF() * @devp: Returns a pointer to the device created - * @return 0 if OK, -EPERM if the device is not needed before relocation and + * Return: 0 if OK, -EPERM if the device is not needed before relocation and * therefore was not created, other -ve value on error */ static int pci_find_and_bind_driver(struct udevice *parent, diff --git a/drivers/pci/pci_common.c b/drivers/pci/pci_common.c index 02a71da30f..a18251297f 100644 --- a/drivers/pci/pci_common.c +++ b/drivers/pci/pci_common.c @@ -236,7 +236,7 @@ int __pci_hose_phys_to_bus(struct pci_controller *hose, * @hose: PCI hose of the root PCI controller * @phys_addr: physical address to convert * @flags: flags of pci regions - * @return bus address if OK, 0 on error + * Return: bus address if OK, 0 on error */ pci_addr_t pci_hose_phys_to_bus(struct pci_controller *hose, phys_addr_t phys_addr, diff --git a/drivers/pci/pci_internal.h b/drivers/pci/pci_internal.h index 8b842f6fb4..5a4c90e619 100644 --- a/drivers/pci/pci_internal.h +++ b/drivers/pci/pci_internal.h @@ -39,7 +39,7 @@ void dm_pciauto_postscan_setup_bridge(struct udevice *dev, int sub_bus); * If the device is a bridge, downstream devices will be probed. * * @dev: Device to configure - * @return the maximum PCI bus number found by this device. If there are no + * Return: the maximum PCI bus number found by this device. If there are no * bridges, this just returns the device's bus number. If the device is a * bridge then it will return a larger number, depending on the devices on * that bridge. On error, returns a -ve error number. @@ -54,7 +54,7 @@ int dm_pciauto_config_device(struct udevice *dev); * * @busnum: PCI bus number to look up * @busp: Returns PCI bus on success - * @return 0 on success, or -ve error + * Return: 0 on success, or -ve error */ int pci_get_bus(int busnum, struct udevice **busp); diff --git a/drivers/pci/pci_rom.c b/drivers/pci/pci_rom.c index 7bad4c82c0..f8b193058a 100644 --- a/drivers/pci/pci_rom.c +++ b/drivers/pci/pci_rom.c @@ -149,7 +149,7 @@ static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp) * @ram_headerp: Returns a pointer to the image in RAM * @allocedp: Returns true if @ram_headerp was allocated and needs * to be freed - * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of + * Return: 0 if OK, -ve on error. Note that @allocedp is set up regardless of * the error state. Even if this function returns an error, it may have * allocated memory. */ |