05 Aug, 2020
1 commit
-
Pull documentation updates from Jonathan Corbet:
"It's been a busy cycle for documentation - hopefully the busiest for a
while to come. Changes include:- Some new Chinese translations
- Progress on the battle against double words words and non-HTTPS
URLs- Some block-mq documentation
- More RST conversions from Mauro. At this point, that task is
essentially complete, so we shouldn't see this kind of churn again
for a while. Unless we decide to switch to asciidoc or
something...:)- Lots of typo fixes, warning fixes, and more"
* tag 'docs-5.9' of git://git.lwn.net/linux: (195 commits)
scripts/kernel-doc: optionally treat warnings as errors
docs: ia64: correct typo
mailmap: add entry for
doc/zh_CN: add cpu-load Chinese version
Documentation/admin-guide: tainted-kernels: fix spelling mistake
MAINTAINERS: adjust kprobes.rst entry to new location
devices.txt: document rfkill allocation
PCI: correct flag name
docs: filesystems: vfs: correct flag name
docs: filesystems: vfs: correct sync_mode flag names
docs: path-lookup: markup fixes for emphasis
docs: path-lookup: more markup fixes
docs: path-lookup: fix HTML entity mojibake
CREDITS: Replace HTTP links with HTTPS ones
docs: process: Add an example for creating a fixes tag
doc/zh_CN: add Chinese translation prefer section
doc/zh_CN: add clearing-warn-once Chinese version
doc/zh_CN: add admin-guide index
doc:it_IT: process: coding-style.rst: Correct __maybe_unused compiler label
futex: MAINTAINERS: Re-add selftests directory
...
14 Jul, 2020
1 commit
-
Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.Deterministic algorithm:
For each file:
If not .svg:
For each line:
If doesn't contain `\bxmlns\b`:
For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.Signed-off-by: Alexander A. Klimov
Link: https://lore.kernel.org/r/20200709182742.24724-1-grandmaster@al2klimov.de
Signed-off-by: Jonathan Corbet
13 Jul, 2020
1 commit
-
Drop the doubled word "the".
Signed-off-by: Randy Dunlap
Reviewed-by: Pierre Morel
Cc: Jonathan Corbet
Cc: linux-doc@vger.kernel.org
Cc: Tony Krowiak
Cc: Pierre Morel
Cc: Halil Pasic
Cc: linux-s390@vger.kernel.org
Link: https://lore.kernel.org/r/20200707180414.10467-17-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet
29 Jun, 2020
1 commit
-
There is not a single user of the debug raw view. Therefore remove it
before anybody uses it. If anybody would make use of the view it would
expose the struct __debug_entry definition to userspace and really
would make it uapi. This wouldn't be good, since the definition is
suboptimal and needs to be changed.Right now the structure definition is only defined to be uapi, however
there is no user.Signed-off-by: Heiko Carstens
09 Jun, 2020
1 commit
-
Pull s390 updates from Vasily Gorbik:
- Add support for multi-function devices in pci code.
- Enable PF-VF linking for architectures using the pdev->no_vf_scan
flag (currently just s390).- Add reipl from NVMe support.
- Get rid of critical section cleanup in entry.S.
- Refactor PNSO CHSC (perform network subchannel operation) in cio and
qeth.- QDIO interrupts and error handling fixes and improvements, more
refactoring changes.- Align ioremap() with generic code.
- Accept requests without the prefetch bit set in vfio-ccw.
- Enable path handling via two new regions in vfio-ccw.
- Other small fixes and improvements all over the code.
* tag 's390-5.8-1' of git://git.kernel.org/pub/scm/linux/kernel/git/s390/linux: (52 commits)
vfio-ccw: make vfio_ccw_regops variables declarations static
vfio-ccw: Add trace for CRW event
vfio-ccw: Wire up the CRW irq and CRW region
vfio-ccw: Introduce a new CRW region
vfio-ccw: Refactor IRQ handlers
vfio-ccw: Introduce a new schib region
vfio-ccw: Refactor the unregister of the async regions
vfio-ccw: Register a chp_event callback for vfio-ccw
vfio-ccw: Introduce new helper functions to free/destroy regions
vfio-ccw: document possible errors
vfio-ccw: Enable transparent CCW IPL from DASD
s390/pci: Log new handle in clp_disable_fh()
s390/cio, s390/qeth: cleanup PNSO CHSC
s390/qdio: remove q->first_to_kick
s390/qdio: fix up qdio_start_irq() kerneldoc
s390: remove critical section cleanup from entry.S
s390: add machine check SIGP
s390/pci: ioremap() align with generic code
s390/ap: introduce new ap function ap_get_qdev()
Documentation/s390: Update / remove developerWorks web links
...
03 Jun, 2020
1 commit
-
This region provides a mechanism to pass a Channel Report Word
that affect vfio-ccw devices, and needs to be passed to the guest
for its awareness and/or processing.The base driver (see crw_collect_info()) provides space for two
CRWs, as a subchannel event may have two CRWs chained together
(one for the ssid, one for the subchannel). As vfio-ccw will
deal with everything at the subchannel level, provide space
for a single CRW to be transferred in one shot.Signed-off-by: Farhan Ali
Signed-off-by: Eric Farman
Reviewed-by: Cornelia Huck
Message-Id:
[CH: added padding to ccw_crw_region]
Signed-off-by: Cornelia Huck
02 Jun, 2020
3 commits
-
The schib region can be used by userspace to get the subchannel-
information block (SCHIB) for the passthrough subchannel.
This can be useful to get information such as channel path
information via the SCHIB.PMCW fields.Signed-off-by: Farhan Ali
Signed-off-by: Eric Farman
Reviewed-by: Cornelia Huck
Message-Id:
Signed-off-by: Cornelia Huck -
Interacting with the I/O and the async regions can yield a number
of errors, which had been undocumented so far. These are part of
the api, so remedy that.Signed-off-by: Cornelia Huck
Reviewed-by: Eric Farman
Message-Id: -
Remove the explicit prefetch check when using vfio-ccw devices.
This check does not trigger in practice as all Linux channel programs
are intended to use prefetch.It is expected that all ORBs issued by Linux will request prefetch.
Although non-prefetching ORBs are not rejected, they will prefetch
nonetheless. A warning is issued up to once per 5 seconds when a
forced prefetch occurs.A non-prefetch ORB does not necessarily result in an error, however
frequent encounters with non-prefetch ORBs indicate that channel
programs are being executed in a way that is inconsistent with what
the guest is requesting. While there is currently no known case of an
error caused by forced prefetch, it is possible in theory that forced
prefetch could result in an error if applied to a channel program that
is dependent on non-prefetch.Signed-off-by: Jared Rossi
Reviewed-by: Eric Farman
Message-Id:
Signed-off-by: Cornelia Huck
20 May, 2020
1 commit
-
s390 documentation now lives in IBM Knowledge Center, so update the link
in the zfcpdump documentation.Also, remove the old developerWorks links from the appldata source code.
Those were not really documentation related, but rather a reminder to the
developer that some documentation has to be adjusted when changing the
record layout, which should still be pretty obvious from the remaining
comment.Signed-off-by: Gerald Schaefer
Signed-off-by: Vasily Gorbik
06 May, 2020
1 commit
-
Clarify the documentation.
Signed-off-by: Pierre Morel
Reviewed-by: Niklas Schnelle
Signed-off-by: Vasily Gorbik
05 May, 2020
1 commit
-
This fixes:
Documentation/s390/vfio-ap.rst:488: WARNING: duplicate label s390/vfio-ap:guest2, other instance in /home/iha/sdb/opensource/lkmp/linux_doc/Documentation/s390/vfio-ap.rst
Signed-off-by: Vitor Massaru Iha
Link: https://lore.kernel.org/r/20200430221238.101838-1-vitor@massaru.org
Signed-off-by: Jonathan Corbet
28 Apr, 2020
1 commit
-
There are changes in the usage of PCI for the user:
- new kernel parameter
- modification of the way functions are enumeratedLet's document these.
Signed-off-by: Pierre Morel
Signed-off-by: Vasily Gorbik
21 Aug, 2019
2 commits
-
This file would need a lot of work to make sense again. Thomas Huth
started working on that four years ago, but that wasn't finished.
Therefore remove this.Signed-off-by: Heiko Carstens
Signed-off-by: Vasily Gorbik -
The contents of the file is completely outdated - just remove it.
Signed-off-by: Heiko Carstens
Signed-off-by: Vasily Gorbik
23 Jul, 2019
1 commit
-
…it/kvms390/vfio-ccw into fixes
Fixes in vfio-ccw for older and newer issues.
17 Jul, 2019
1 commit
-
*Really* mark the literal block as such.
Fixes: 127e62174041 ("vfio-ccw: Update documentation for csch/hsch")
Signed-off-by: Cornelia Huck
15 Jul, 2019
4 commits
-
Nested tables aren't supported for pdf output on Sphinx 1.7.9:
admin-guide/laptops/sonypi:: nested tables are not yet implemented.
admin-guide/laptops/toshiba_haps:: nested tables are not yet implemented.
driver-api/nvdimm/btt:: nested tables are not yet implemented.
s390/debugging390:: nested tables are not yet implemented.Signed-off-by: Mauro Carvalho Chehab
Acked-by: Andy Shevchenko # laptops -
There are lots of documents under Documentation/*.txt and a few other
orphan documents elsehwere that belong to the driver-API book.Move them to their right place.
Reviewed-by: Cornelia Huck # vfio-related parts
Acked-by: Logan Gunthorpe # switchtec
Signed-off-by: Mauro Carvalho Chehab -
Now that several arch documents were converted to ReST,
add their indexes to Documentation/index.rst and remove the
:orphan: from them.Signed-off-by: Mauro Carvalho Chehab
-
We now support CLEAR SUBCHANNEL and HALT SUBCHANNEL
via ccw_cmd_region.Fixes: d5afd5d135c8 ("vfio-ccw: add handling for async channel instructions")
Signed-off-by: Farhan Ali
Message-Id:
[CH: properly mark region as literal block]
Reviewed-by: Cornelia Huck
Reviewed-by: Eric Farman
Signed-off-by: Cornelia Huck
05 Jul, 2019
3 commits
-
Signed-off-by: Steffen Maier
Acked-by: Christian Borntraeger
Message-Id:
Signed-off-by: Vasily Gorbik -
For non-static-inlines, debug.c already had non-compliant function
header docs. So move the pure prototype kdocs of
("s390: include/asm/debug.h add kerneldoc markups")
from debug.h to debug.c and merge them with the old function docs.
Also, I had the impression that kdoc typically is at the implementation
in the compile unit rather than at the prototype in the header file.While at it, update the short kdoc description to distinguish the
different functions. And a few more consistency cleanups.Added a new kdoc for debug_set_critical() since debug.h comments it
as part of the API.Signed-off-by: Steffen Maier
Acked-by: Christian Borntraeger
Message-Id:
Signed-off-by: Vasily Gorbik -
Complements previous ("s390: include/asm/debug.h add kerneldoc markups")
which seemed to have dropped important non-kdoc parts such as
user space interface (level, size, flush)
as well as views and caution regarding strings in the sprintf view.Signed-off-by: Steffen Maier
Acked-by: Christian Borntraeger
Message-Id:
Signed-off-by: Vasily Gorbik
11 Jun, 2019
3 commits
-
Instead of keeping the documentation inside s390dbf.rst,
move them to arch/s390/include/asm/debug.h, using standard
kernel-doc markups.Keeping the documentation close to the code helps to keep it
updated. It also makes easier to document other stuff inside
debug.h, as all it needs is to add kernel-doc markups inside
it, as the file will be already be included at the produced
documentation.-
Those were converted to kerneldoc using this script specially
designed to parse ths file, and manually editted:Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Heiko Carstens -
Convert all text files with s390 documentation to ReST format.
Tried to preserve as much as possible the original document
format. Still, some of the files required some work in order
for it to be visible on both plain text and after converted
to html.The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Heiko Carstens -
The first bit/value table inside the document is very
hard to read and won't fit ReST format. Also, some columns aren't
properly aligned.Convert it to a nice ascii artwork table with makes it easier to
read as plain text and is compatible with ReST format parser
on Sphinx.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Heiko Carstens
21 Nov, 2018
1 commit
-
Whilst making an unrelated change to some Documentation, Linus sayeth:
| Afaik, even in Britain, "whilst" is unusual and considered more
| formal, and "while" is the common word.
|
| [...]
|
| Can we just admit that we work with computers, and we don't need to
| use þe eald Englisc spelling of words that most of the world never
| uses?dictionary.com refers to the word as "Chiefly British", which is
probably an undesirable attribute for technical documentation.Replace all occurrences under Documentation/ with "while".
Cc: David Howells
Cc: Liam Girdwood
Cc: Chris Wilson
Cc: Michael Halcrow
Cc: Jonathan Corbet
Reported-by: Linus Torvalds
Signed-off-by: Will Deacon
Signed-off-by: Jonathan Corbet
26 Oct, 2018
1 commit
-
Pull KVM updates from Radim Krčmář:
"ARM:
- Improved guest IPA space support (32 to 52 bits)- RAS event delivery for 32bit
- PMU fixes
- Guest entry hardening
- Various cleanups
- Port of dirty_log_test selftest
PPC:
- Nested HV KVM support for radix guests on POWER9. The performance
is much better than with PR KVM. Migration and arbitrary level of
nesting is supported.- Disable nested HV-KVM on early POWER9 chips that need a particular
hardware bug workaround- One VM per core mode to prevent potential data leaks
- PCI pass-through optimization
- merge ppc-kvm topic branch and kvm-ppc-fixes to get a better base
s390:
- Initial version of AP crypto virtualization via vfio-mdev- Improvement for vfio-ap
- Set the host program identifier
- Optimize page table locking
x86:
- Enable nested virtualization by default- Implement Hyper-V IPI hypercalls
- Improve #PF and #DB handling
- Allow guests to use Enlightened VMCS
- Add migration selftests for VMCS and Enlightened VMCS
- Allow coalesced PIO accesses
- Add an option to perform nested VMCS host state consistency check
through hardware- Automatic tuning of lapic_timer_advance_ns
- Many fixes, minor improvements, and cleanups"
* tag 'kvm-4.20-1' of git://git.kernel.org/pub/scm/virt/kvm/kvm: (204 commits)
KVM/nVMX: Do not validate that posted_intr_desc_addr is page aligned
Revert "kvm: x86: optimize dr6 restore"
KVM: PPC: Optimize clearing TCEs for sparse tables
x86/kvm/nVMX: tweak shadow fields
selftests/kvm: add missing executables to .gitignore
KVM: arm64: Safety check PSTATE when entering guest and handle IL
KVM: PPC: Book3S HV: Don't use streamlined entry path on early POWER9 chips
arm/arm64: KVM: Enable 32 bits kvm vcpu events support
arm/arm64: KVM: Rename function kvm_arch_dev_ioctl_check_extension()
KVM: arm64: Fix caching of host MDCR_EL2 value
KVM: VMX: enable nested virtualization by default
KVM/x86: Use 32bit xor to clear registers in svm.c
kvm: x86: Introduce KVM_CAP_EXCEPTION_PAYLOAD
kvm: vmx: Defer setting of DR6 until #DB delivery
kvm: x86: Defer setting of CR2 until #PF delivery
kvm: x86: Add payload operands to kvm_multiple_exception
kvm: x86: Add exception payload fields to kvm_vcpu_events
kvm: x86: Add has_payload and payload to kvm_queued_exception
KVM: Documentation: Fix omission in struct kvm_vcpu_events
KVM: selftests: add Enlightened VMCS test
...
28 Sep, 2018
1 commit
-
This patch provides documentation describing the AP architecture and
design concepts behind the virtualization of AP devices. It also
includes an example of how to configure AP devices for exclusive
use of KVM guests.Signed-off-by: Tony Krowiak
Reviewed-by: Halil Pasic
Message-Id:
Signed-off-by: Christian Borntraeger
10 Sep, 2018
1 commit
-
This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way, so my apologies for ruining your inbox.The 00-INDEX files are supposed to give a summary of all files present
in a directory, but these files are horribly out of date and their
usefulness is brought into question. Often a simple "ls" would reveal
the same information as the filenames are generally quite descriptive as
a short introduction to what the file covers (it should not surprise
anyone what Documentation/sched/sched-design-CFS.txt covers)A few years back it was mentioned that these files were no longer really
needed, and they have since then grown further out of date, so perhaps
it is time to just throw them out.A short status yields the following _outdated_ 00-INDEX files, first
counter is files listed in 00-INDEX but missing in the directory, last
is files present but not listed in 00-INDEX.List of outdated 00-INDEX:
Documentation: (4/10)
Documentation/sysctl: (0/1)
Documentation/timers: (1/0)
Documentation/blockdev: (3/1)
Documentation/w1/slaves: (0/1)
Documentation/locking: (0/1)
Documentation/devicetree: (0/5)
Documentation/power: (1/1)
Documentation/powerpc: (0/5)
Documentation/arm: (1/0)
Documentation/x86: (0/9)
Documentation/x86/x86_64: (1/1)
Documentation/scsi: (4/4)
Documentation/filesystems: (2/9)
Documentation/filesystems/nfs: (0/2)
Documentation/cgroup-v1: (0/2)
Documentation/kbuild: (0/4)
Documentation/spi: (1/0)
Documentation/virtual/kvm: (1/0)
Documentation/scheduler: (0/2)
Documentation/fb: (0/1)
Documentation/block: (0/1)
Documentation/networking: (6/37)
Documentation/vm: (1/3)Then there are 364 subdirectories in Documentation/ with several files that
are missing 00-INDEX alltogether (and another 120 with a single file and no
00-INDEX).I don't really have an opinion to whether or not we /should/ have 00-INDEX,
but the above 00-INDEX should either be removed or be kept up to date. If
we should keep the files, I can try to keep them updated, but I rather not
if we just want to delete them anyway.As a starting point, remove all index-files and references to 00-INDEX and
see where the discussion is going.Signed-off-by: Henrik Austad
Acked-by: "Paul E. McKenney"
Just-do-it-by: Steven Rostedt
Reviewed-by: Jens Axboe
Acked-by: Paul Moore
Acked-by: Greg Kroah-Hartman
Acked-by: Mark Brown
Acked-by: Mike Rapoport
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet
02 Mar, 2018
1 commit
-
The vfio-ccw documentation comes from the cover letter of the
original patch submission, which shows in some parts. Give it some
love; in particular:- Remove/rework statements that make sense in a cover letter, but not
in regular documentation.
- Fix some typos.
- Describe the current limitations in more detail.Acked-by: Halil Pasic
Reviewed-by: Dong Jia Shi
Signed-off-by: Cornelia Huck
31 Mar, 2017
1 commit
-
Add file Documentation/s390/vfio-ccw.txt that includes details
of vfio-ccw.Acked-by: Pierre Morel
Signed-off-by: Dong Jia Shi
Message-Id:
Signed-off-by: Cornelia Huck
04 Mar, 2017
1 commit
-
Commit 9d85025b0418 ("docs-rst: create an user's manual book") moved the
sysrq.txt leaving old paths in the kernel docs.Signed-off-by: Krzysztof Kozlowski
Reviewed-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
13 Jun, 2016
1 commit
-
When s390 traces with hex_ascii or sprintf view are
extracted and sorted, use the sort option -s (stable)
to avoid multiple lines with the same time stamp being
sorted using the rest of the line as secondary key.Signed-off-by: Thomas Richter
Signed-off-by: Martin Schwidefsky
27 Nov, 2015
1 commit
-
New versions of the SCSI dumper use the /dev/vmcore interface instead
of zcore mem. Remove the outdated interface.Acked-by: Michael Holzheu
Signed-off-by: Martin Schwidefsky
29 Jul, 2015
1 commit
-
The old Documentation/s390/kvm.txt file is either
outdated or described in Documentation/virtual/kvm/api.txt.
Let's get rid of it.Signed-off-by: Christian Borntraeger
Reviewed-by: David Hildenbrand
19 May, 2015
1 commit
-
OSA Ethernet hardware is introducing BRIDGEPORT functionality
similar (but not identical) to HiperSockets BRIDGEPORT. This
patch makes HiperSockets BRIDGEPORT related sysfs attributes
and udev events work with OSA hardware too.Reviewed-by: Thomas Richter
Signed-off-by: Eugene Crosser
Signed-off-by: Ursula Braun
Signed-off-by: David S. Miller
15 Jan, 2015
2 commits
-
The section about debugging scripting languages has nothing to do with
s390 (and the example is even apparently taken from a i586 host instead),
so let's remove this chapter from the file.Signed-off-by: Thomas Huth
Signed-off-by: Martin Schwidefsky -
There are a lot of lines that are longer than 80 columns in this file,
rendering it hard to read in a terminal window. This patch fixes most
of these long lines, and while we're at it, also makes some sentences
more readable, e.g. by replacing "&" with "and", adding proper
punctuation, removing superfluous clauses, etc.Signed-off-by: Thomas Huth
Signed-off-by: Martin Schwidefsky
