There are stray Unicode quotation marks (U+201C DOUBLE TURNED COMMA
QUOTATION MARK) in the file. Remove them, as they don't serve a purpose.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
This prevents the chapter headings from showing up in the table of
contents in filesystems/index.html.
Note that I didn't pick "UBIFS Authentication" as the document title,
because there is a chapter of the same name, and Sphinx complains about
multiple headings with the same name:
/.../Documentation/filesystems/ubifs-authentication.rst:207:
WARNING: duplicate label filesystems/ubifs-authentication:ubifs
authentication, other instance in
/.../Documentation/filesystems/ubifs-authentication.rst
Remove the :orphan: tag, as the document has been included into the
toctree.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
This reverts commit f452ee096d.
The workaround became unnecessary with commit 43756e347f
("scripts/kernel-doc: Add support for named variable macro arguments").
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Paul E. McKenney <[email protected]>
Character arrays can be considered empty strings (if they are
immediately terminated), but they cannot be NULL.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Bartosz Golaszewski <[email protected]>
rhashtable_lookup_get_insert_key doesn't have a parameter `data`. It
does have a parameter `key`, however.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: Herbert Xu <[email protected]>
Signed-off-by: David S. Miller <[email protected]>
The new syntax is available since commit 43756e347f
("scripts/kernel-doc: Add support for named variable macro arguments").
The same HTML output is produced with and without this patch.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Hans Verkuil <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Before commit 9e03ea7f68 ("Documentation/kernel-docs.txt: convert it
to ReST markup"), it read:
Description: Linux Journal Kernel Korner article. Here is its
abstract: "..."
In Sphinx' HTML formatting, however, the "Here is its" doesn't make
sense anymore, because the "Abstract:" is clearly separated.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
- Don't use `tmp` for two purposes (return value, loop counter).
Instead, use `i` for the loop counter, and `ret` for the return value.
- Don't use tabs between type and name in variable declarations,
for consistency with other functions in spi-nor.c.
- Rewrite nested `if`s as `if (a && b)`.
- Remove `info` variable, and use spi_nor_ids[i] directly.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
[[email protected]: change i's type from int to unsigned int,
reorder local variables]
Signed-off-by: Tudor Ambarus <[email protected]>
It has been merged into sleep-states.rst.
Fixes: c21502efda ("Documentation: admin-guide: PM: Update sleep states documentation")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Rafael J. Wysocki <[email protected]>
When both the documentation and the data files lived in
Documentation/EDID, this wasn't necessary, but both have
been moved to other directories in the meantime.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This document describes actions that an admin can do, rather than
interfaces available to driver developers, so admin-guide seems to
be a more appropriate place for it.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Without the empty lines, Sphinx renders the list as part of the running
text.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
cmdlinepart.c has been moved to drivers/mtd/parsers/.
Fixes: a3f12a35c9 ("mtd: parsers: Move CMDLINE parser")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Without this patch, Sphinx shows "variable arguments" as the description
of the cond argument, rather than the intended description, and prints
the following warnings:
./include/linux/rculist.h:374: warning: Excess function parameter 'cond' description in 'list_for_each_entry_rcu'
./include/linux/rculist.h:651: warning: Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu'
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: Joel Fernandes (Google) <[email protected]>
Signed-off-by: Paul E. McKenney <[email protected]>
Currently, when kernel-doc encounters a macro with a named variable
argument[1], such as this:
#define hlist_for_each_entry_rcu(pos, head, member, cond...)
... it expects the variable argument to be documented as `cond...`,
rather than `cond`. This is semantically wrong, because the name (as
used in the macro body) is actually `cond`.
With this patch, kernel-doc will accept the name without dots (`cond`
in the example above) in doc comments, and warn if the name with dots
(`cond...`) is used and verbose mode[2] is enabled.
The support for the `cond...` syntax can be removed later, when the
documentation of all such macros has been switched to the new syntax.
Testing this patch on top of v5.4-rc6, `make htmldocs` shows a few
changes in log output and HTML output:
1) The following warnings[3] are eliminated:
./include/linux/rculist.h:374: warning:
Excess function parameter 'cond' description in 'list_for_each_entry_rcu'
./include/linux/rculist.h:651: warning:
Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu'
2) For list_for_each_entry_rcu and hlist_for_each_entry_rcu, the
correct description is shown
3) Named variable arguments are shown without dots
[1]: https://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html
[2]: scripts/kernel-doc -v
[3]: See also https://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git/commit/?h=dev&id=5bc4bc0d6153617eabde275285b7b5a8137fdf3c
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Tested-by: Paul E. McKenney <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
These asterisks were once references to a line that said:
"* Other names and brands may be claimed as the property of others."
But now, they serve no purpose; they can only irritate the reader.
Fixes: de3edab427 ("e1000: update README for e1000")
Fixes: a3fb65680f ("e100.txt: Cleanup license info in kernel doc")
Fixes: da8c01c450 ("e1000e.txt: Add e1000e documentation")
Fixes: f12a84a9f6 ("Documentation: fm10k: Add kernel documentation")
Fixes: b55c52b193 ("igb.txt: Add igb documentation")
Fixes: c4e9b56e24 ("igbvf.txt: Add igbvf Documentation")
Fixes: d7064f4c19 ("Documentation/networking/: Update Intel wired LAN driver documentation")
Fixes: c4b8c01112 ("ixgbevf.txt: Update ixgbevf documentation")
Fixes: 1e06edcc2f ("Documentation: i40e: Prepare documentation for RST conversion")
Fixes: 105bf2fe6b ("i40evf: add driver to kernel build system")
Fixes: 1fae869bcf ("Documentation: ice: Prepare documentation for RST conversion")
Fixes: df69ba4321 ("ionic: Add basic framework for IONIC Network device driver")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Tested-by: Aaron Brown <[email protected]>
Signed-off-by: Jeff Kirsher <[email protected]>
ReST directives are introduced with two dots.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
ReST directives are introduced with two dots.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
- Mention the driver name, which is also used in sysfs (dell_rbu)
- Rewrite the title to be more concise
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This document describes how an admin can use the dell_rbu driver, rather
than any in-kernel API details.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: Andy Shevchenko <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Since the "unordered guides" linked in admin-guide/index.rst are not
supposed to be in any particular order, let's sort them alphabetically
to avoid the risk of merge conflicts by spreading newly added lines more
evenly.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
It's not about times (multiple occurences of an event) but about the
duration of a time interval.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: David S. Miller <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This fixes the following Sphinx warning:
Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim
Fixes: 9e08745704 ("Documentation: Add description of netdevsim traps")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: David S. Miller <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
These asterisks were once references to a line that said:
"* Other names and brands may be claimed as the property of others."
But now, they serve no purpose; they can only irritate the reader.
Fixes: f12a84a9f6 ("Documentation: fm10k: Add kernel documentation")
Fixes: 1e06edcc2f ("Documentation: i40e: Prepare documentation for RST conversion")
Fixes: 1fae869bcf ("Documentation: ice: Prepare documentation for RST conversion")
Fixes: df69ba4321 ("ionic: Add basic framework for IONIC Network device driver")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: Shannon Nelson <[email protected]>
Acked-by: David S. Miller <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This fixes the following Sphinx warning:
Documentation/translations/it_IT/process/maintainer-pgp-guide.rst:458:
WARNING: Unknown target name: "nitrokey pro".
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This fixes a lot of Sphinx warnings, and makes the code blocks look nice
in HTML.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Bartosz Golaszewski <[email protected]>
This improves Sphinx output in two ways:
- It avoids an unmatched single-quote ('), about which Sphinx complained:
Documentation/gpu/drm-internals.rst:298:
WARNING: Could not lex literal_block as "c". Highlighting skipped.
An alternative approach would be to replace "can't" with a word that
doesn't have a single-quote.
- It lets Sphinx format the comments in italics and grey, making the
code slightly easier to read.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Acked-by: Daniel Vetter <[email protected]> [via irc]
Signed-off-by: Sam Ravnborg <[email protected]>
Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
This fixes the following Sphinx warning:
Documentation/crypto/crypto_engine.rst:2:
WARNING: Explicit markup ends without a blank line; unexpected unindent.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Herbert Xu <[email protected]>
It seems a UTF-8 byte order mark (the least useful kind of BOM...) snuck
into the file and broke Sphinx's detection of the title line.
Besides making arm/samsung-s3c24xx/index.html look a little better, this
patch also confines the non-index pages in arm/samsung-s3c24xx to their
own table of contents.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
The support for the following boards, among others, was removed in 2004
with commit "[ARM] Remove broken SA1100 machine support.":
- ADS Bitsy
- Brutus
- Freebird
- ADS GraphicsClient Plus
- ADS GraphicsMaster
- Höft & Wessel Webpanel
- Compaq Itsy
- nanoEngine
- Pangolin
- PLEB
- Yopy
Tifon support has been removed in 2.4.3.3.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
With the introduction of Documentation/sphinx/automarkup.py, socket() is
parsed as a reference to the in-kernel definition of socket. Sphinx then
decides that struct socket is a good match, which is usually not
intended, when the syscall is meant instead. This was observed in
Documentation/networking/af_xdp.rst.
Prevent socket() from being misinterpreted by adding it to the Skipfuncs
list in automarkup.py.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Reviewed-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
In Python, like in C, when a comma is omitted in a list of strings, the
two strings around the missing comma are concatenated.
Cc: [email protected] # v5.2 only
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Reviewed-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
The RN5T618 family of PMICs can be used as system management
controllers, in which case they handle poweroff and restart. Document
this capability by referring to the corresponding generic DT binding.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
Adjust the function names in two doc comments to match the corresponding
functions.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: David S. Miller <[email protected]>
BUG_ON(x) should raise an error if x is true, but assert(x) raises an
error if x is false. Remove this bogus definition of BUG_ON(), which
isn't used anyway.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Michael S. Tsirkin <[email protected]>
"sysfs" was misspelled in a comment and a log message.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Reviewed-by: Mukesh Ojha <[email protected]>
Signed-off-by: Greg Kroah-Hartman <[email protected]>
Since commit 222b5f0441 ("drm/sched: Refactor ring mirror list
handling."), drm_sched_hw_job_reset is no longer there, so let's adjust
the doc comment accordingly.
Reviewed-by: Andrey Grodzovsky <[email protected]>
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Alex Deucher <[email protected]>
The Kobo Aura is an e-book reader released in 2013.
With the devicetree in its current state, the kernel will boot and run
for about ten seconds. To solve this, the embedded controller needs to
be told that the system should stay powered on. This will be done in a
later patchset.
- The IOMUXC mode bits for the SD interfaces were taken from the
vendor's U-Boot fork.
- The bus width of the eMMC is 4 bits in the vendor kernel, but I
achieved better performance with 8 bits.
- The SDIO clock frequency for the WiFi chip is 25MHz in the vendor
kernel, but the WiFi chip (BCM43362) supports 50MHz, which works
reliably on this board and gives slightly better performance.
- The I2C pins' IOMUXC settings come from the vendor's U-Boot fork.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Shawn Guo <[email protected]>
fsl,imx50-evk has been used in a devicetree for a while. kobo,aura will
be used soon.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Shawn Guo <[email protected]>
It's unnecessary to point to an external mirror of the Documentation
directory.
Jonathan Corbet writes in favor of removing this entry, instead of
moving it under "Docs at the Linux Kernel tree":
> We don't want to turn kernel-docs.rst into yet another out-of-date
> index for the rest of Documentation/, and the removal of the external
> URL takes away the only bit of additional information that this entry
> offers.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
The MUX bits for esdhc_{a,c,d}_sel are shifted by one bit within CSCMR1,
because esdhc_b_sel (ESDHC3_CLK_SEL in the Reference Manual) is extended
by one bit.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Shawn Guo <[email protected]>
i.MX50 does not have a periph_apm clock. Instead, the main bus clock
(a.k.a. periph_clk) comes directly from a MUX between pll1_sw, pll2_sw,
pll3_sw, and lp_apm.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Shawn Guo <[email protected]>
The way the document is written now, Sphinx renders empty code blocks
followed by the lines that should be inside them.
Unindent the code-block directives to fix this.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Even though the ChipIdea USB controller binding[1] doesn't specify the
properties that reference a PHY as required, the Linux driver
requires[2] such a reference.
The clock situation is like on i.MX53: The USB controller is clocked
from IMX5_CLK_USBOH3_GATE and the PHY from IMX5_CLK_USB_PHY1_GATE.
[1]: Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt
[2]: Search for EINVAL in drivers/usb/chipidea/ci_hdrc_imx.c
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Shawn Guo <[email protected]>
When using the mmc_spi driver with a card-detect pin, I noticed that the
card was not detected immediately after probe, but only after it was
unplugged and plugged back in (and the CD IRQ fired).
The call tree looks something like this:
mmc_spi_probe
mmc_add_host
mmc_start_host
_mmc_detect_change
mmc_schedule_delayed_work(&host->detect, 0)
mmc_rescan
host->bus_ops->detect(host)
mmc_detect
_mmc_detect_card_removed
host->ops->get_cd(host)
mmc_gpio_get_cd -> -ENOSYS (ctx->cd_gpio not set)
mmc_gpiod_request_cd
ctx->cd_gpio = desc
To fix this issue, call mmc_detect_change after the card-detect GPIO/IRQ
is registered.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Reviewed-by: Linus Walleij <[email protected]>
Cc: [email protected]
Signed-off-by: Ulf Hansson <[email protected]>
AFAICS from the i.MX50 Reference Manual, the i.MX50 IOMUXC works the
same as the one in i.MX51, so I copied fsl,imx51-pinctrl.txt and changed
the text to imx50.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Cc: Dong Aisheng <[email protected]>
Cc: Shawn Guo <[email protected]>
Reviewed-by: Fabio Estevam <[email protected]>
Signed-off-by: Linus Walleij <[email protected]>
The spi-gpio driver already handles different chip select polarities,
but so far this was not advertised in master->mode_bits.
This patch fixes mmc_spi on top of spi_gpio, which is useful in some
testing scenarios.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Mark Brown <[email protected]>
There's no need to use an external link when the file is already here.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Tony Lindgren <[email protected]>
This patch implements level-triggered IRQs in the Hollywood GPIO driver.
Edge triggered interrupts are not supported in this GPIO controller, so
I moved their emulation into a separate patch.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Linus Walleij <[email protected]>
This comment has been wrong since before git.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Geert Uytterhoeven <[email protected]>
"also enables" should not be spelled as one word.
Fixes: cfc80d9a11 ("net: Introduce net_failover driver")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: David S. Miller <[email protected]>
This typo inverted the meaning of the comment, but the rest of the
comment and the code reveal that the regulator in question needs to be
on at all times.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Maxime Ripard <[email protected]>
The Wii has POWER and EJECT buttons, which are connected through
normalization logic to the GPIO controller (the length of an assertion
of these signals is always the same, regardless of how long the user
pressed the buttons).
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Michael Ellerman <[email protected]>
The Hollywood GPIO controller is connected to the Hollywood PIC (&PIC1)
at IRQs 10 and 11; IRQ 10 for GPIO lines that are configured for access
by the PPC, 11 for GPIO lines that are configured for access by the
ARM926.
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Michael Ellerman <[email protected]>
UNAME26 is a mechanism to report Linux's version as 2.6.x, for
compatibility with old/broken software. Due to the way it is
implemented, it would have to be updated after 5.0, to keep the
resulting versions unique. Linus Torvalds argued:
"Do we actually need this?
I'd rather let it bitrot, and just let it return random versions. It
will just start again at 2.4.60, won't it?
Anybody who uses UNAME26 for a 5.x kernel might as well think it's
still 4.x. The user space is so old that it can't possibly care about
differences between 4.x and 5.x, can it?
The only thing that matters is that it shows "2.4.<largeenough>",
which it will do regardless"
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
The workaround has been removed. What stays is just code to find the
memory hole so the BATs can be configured properly in the function below.
Fixes: 57deb8fea0 ("powerpc/wii: Don't rely on the reserved memory hack")
Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Michael Ellerman <[email protected]>
Jonathan Neuschäfer