You've already forked linux-apfs
mirror of
https://github.com/linux-apfs/linux-apfs.git
synced 2026-05-01 15:00:59 -07:00
trivial: Miscellaneous documentation typo fixes
Fix various typos in documentation txts. Signed-off-by: Matt LaPlante <kernel1@cyberdogtech.com> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
This commit is contained in:
committed by
Jiri Kosina
parent
19af5cdb7c
commit
19f5946001
@@ -676,8 +676,8 @@ this directory the following files can currently be found:
|
|||||||
dma-api/all_errors This file contains a numeric value. If this
|
dma-api/all_errors This file contains a numeric value. If this
|
||||||
value is not equal to zero the debugging code
|
value is not equal to zero the debugging code
|
||||||
will print a warning for every error it finds
|
will print a warning for every error it finds
|
||||||
into the kernel log. Be carefull with this
|
into the kernel log. Be careful with this
|
||||||
option. It can easily flood your logs.
|
option, as it can easily flood your logs.
|
||||||
|
|
||||||
dma-api/disabled This read-only file contains the character 'Y'
|
dma-api/disabled This read-only file contains the character 'Y'
|
||||||
if the debugging code is disabled. This can
|
if the debugging code is disabled. This can
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ to another chain) checking the final 'nulls' value if
|
|||||||
the lookup met the end of chain. If final 'nulls' value
|
the lookup met the end of chain. If final 'nulls' value
|
||||||
is not the slot number, then we must restart the lookup at
|
is not the slot number, then we must restart the lookup at
|
||||||
the beginning. If the object was moved to the same chain,
|
the beginning. If the object was moved to the same chain,
|
||||||
then the reader doesnt care : It might eventually
|
then the reader doesn't care : It might eventually
|
||||||
scan the list again without harm.
|
scan the list again without harm.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Copyright 2006, 2007 Simtec Electronics
|
|||||||
|
|
||||||
The Silicon Motion SM501 multimedia companion chip is a multifunction device
|
The Silicon Motion SM501 multimedia companion chip is a multifunction device
|
||||||
which may provide numerous interfaces including USB host controller USB gadget,
|
which may provide numerous interfaces including USB host controller USB gadget,
|
||||||
Asyncronous Serial ports, Audio functions and a dual display video interface.
|
asynchronous serial ports, audio functions, and a dual display video interface.
|
||||||
The device may be connected by PCI or local bus with varying functions enabled.
|
The device may be connected by PCI or local bus with varying functions enabled.
|
||||||
|
|
||||||
Core
|
Core
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ same criteria as reads.
|
|||||||
front_merges (bool)
|
front_merges (bool)
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Sometimes it happens that a request enters the io scheduler that is contigious
|
Sometimes it happens that a request enters the io scheduler that is contiguous
|
||||||
with a request that is already on the queue. Either it fits in the back of that
|
with a request that is already on the queue. Either it fits in the back of that
|
||||||
request, or it fits at the front. That is called either a back merge candidate
|
request, or it fits at the front. That is called either a back merge candidate
|
||||||
or a front merge candidate. Due to the way files are typically laid out,
|
or a front merge candidate. Due to the way files are typically laid out,
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ parameter.
|
|||||||
|
|
||||||
For simplicity, only one braille console can be enabled, other uses of
|
For simplicity, only one braille console can be enabled, other uses of
|
||||||
console=brl,... will be discarded. Also note that it does not interfere with
|
console=brl,... will be discarded. Also note that it does not interfere with
|
||||||
the console selection mecanism described in serial-console.txt
|
the console selection mechanism described in serial-console.txt
|
||||||
|
|
||||||
For now, only the VisioBraille device is supported.
|
For now, only the VisioBraille device is supported.
|
||||||
|
|
||||||
|
|||||||
@@ -188,7 +188,7 @@ For example, you can do something like the following.
|
|||||||
|
|
||||||
void my_midlayer_destroy_something()
|
void my_midlayer_destroy_something()
|
||||||
{
|
{
|
||||||
devres_release_group(dev, my_midlayer_create_soemthing);
|
devres_release_group(dev, my_midlayer_create_something);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -23,8 +23,8 @@ first time, it was renamed to 'EDAC'.
|
|||||||
The bluesmoke project at sourceforge.net is now utilized as a 'staging area'
|
The bluesmoke project at sourceforge.net is now utilized as a 'staging area'
|
||||||
for EDAC development, before it is sent upstream to kernel.org
|
for EDAC development, before it is sent upstream to kernel.org
|
||||||
|
|
||||||
At the bluesmoke/EDAC project site, is a series of quilt patches against
|
At the bluesmoke/EDAC project site is a series of quilt patches against
|
||||||
recent kernels, stored in a SVN respository. For easier downloading, there
|
recent kernels, stored in a SVN repository. For easier downloading, there
|
||||||
is also a tarball snapshot available.
|
is also a tarball snapshot available.
|
||||||
|
|
||||||
============================================================================
|
============================================================================
|
||||||
@@ -73,9 +73,9 @@ the vendor should tie the parity status bits to 0 if they do not intend
|
|||||||
to generate parity. Some vendors do not do this, and thus the parity bit
|
to generate parity. Some vendors do not do this, and thus the parity bit
|
||||||
can "float" giving false positives.
|
can "float" giving false positives.
|
||||||
|
|
||||||
In the kernel there is a pci device attribute located in sysfs that is
|
In the kernel there is a PCI device attribute located in sysfs that is
|
||||||
checked by the EDAC PCI scanning code. If that attribute is set,
|
checked by the EDAC PCI scanning code. If that attribute is set,
|
||||||
PCI parity/error scannining is skipped for that device. The attribute
|
PCI parity/error scanning is skipped for that device. The attribute
|
||||||
is:
|
is:
|
||||||
|
|
||||||
broken_parity_status
|
broken_parity_status
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
SH7760/SH7763 integrated LCDC Framebuffer driver
|
SH7760/SH7763 integrated LCDC Framebuffer driver
|
||||||
================================================
|
================================================
|
||||||
|
|
||||||
0. Overwiew
|
0. Overview
|
||||||
-----------
|
-----------
|
||||||
The SH7760/SH7763 have an integrated LCD Display controller (LCDC) which
|
The SH7760/SH7763 have an integrated LCD Display controller (LCDC) which
|
||||||
supports (in theory) resolutions ranging from 1x1 to 1024x1024,
|
supports (in theory) resolutions ranging from 1x1 to 1024x1024,
|
||||||
|
|||||||
@@ -369,7 +369,7 @@ The call requires an initialized struct autofs_dev_ioctl. There are two
|
|||||||
possible variations. Both use the path field set to the path of the mount
|
possible variations. Both use the path field set to the path of the mount
|
||||||
point to check and the size field adjusted appropriately. One uses the
|
point to check and the size field adjusted appropriately. One uses the
|
||||||
ioctlfd field to identify a specific mount point to check while the other
|
ioctlfd field to identify a specific mount point to check while the other
|
||||||
variation uses the path and optionaly arg1 set to an autofs mount type.
|
variation uses the path and optionally arg1 set to an autofs mount type.
|
||||||
The call returns 1 if this is a mount point and sets arg1 to the device
|
The call returns 1 if this is a mount point and sets arg1 to the device
|
||||||
number of the mount and field arg2 to the relevant super block magic
|
number of the mount and field arg2 to the relevant super block magic
|
||||||
number (described below) or 0 if it isn't a mountpoint. In both cases
|
number (described below) or 0 if it isn't a mountpoint. In both cases
|
||||||
|
|||||||
@@ -184,7 +184,7 @@ This has the following fields:
|
|||||||
have index children.
|
have index children.
|
||||||
|
|
||||||
If this function is not supplied or if it returns NULL then the first
|
If this function is not supplied or if it returns NULL then the first
|
||||||
cache in the parent's list will be chosed, or failing that, the first
|
cache in the parent's list will be chosen, or failing that, the first
|
||||||
cache in the master list.
|
cache in the master list.
|
||||||
|
|
||||||
(4) A function to retrieve an object's key from the netfs [mandatory].
|
(4) A function to retrieve an object's key from the netfs [mandatory].
|
||||||
|
|||||||
@@ -294,7 +294,7 @@ max_batch_time=usec Maximum amount of time ext4 should wait for
|
|||||||
amount of time (on average) that it takes to
|
amount of time (on average) that it takes to
|
||||||
finish committing a transaction. Call this time
|
finish committing a transaction. Call this time
|
||||||
the "commit time". If the time that the
|
the "commit time". If the time that the
|
||||||
transactoin has been running is less than the
|
transaction has been running is less than the
|
||||||
commit time, ext4 will try sleeping for the
|
commit time, ext4 will try sleeping for the
|
||||||
commit time to see if other operations will join
|
commit time to see if other operations will join
|
||||||
the transaction. The commit time is capped by
|
the transaction. The commit time is capped by
|
||||||
@@ -328,7 +328,7 @@ noauto_da_alloc replacing existing files via patterns such as
|
|||||||
journal commit, in the default data=ordered
|
journal commit, in the default data=ordered
|
||||||
mode, the data blocks of the new file are forced
|
mode, the data blocks of the new file are forced
|
||||||
to disk before the rename() operation is
|
to disk before the rename() operation is
|
||||||
commited. This provides roughly the same level
|
committed. This provides roughly the same level
|
||||||
of guarantees as ext3, and avoids the
|
of guarantees as ext3, and avoids the
|
||||||
"zero-length" problem that can happen when a
|
"zero-length" problem that can happen when a
|
||||||
system crashes before the delayed allocation
|
system crashes before the delayed allocation
|
||||||
@@ -358,7 +358,7 @@ written to the journal first, and then to its final location.
|
|||||||
In the event of a crash, the journal can be replayed, bringing both data and
|
In the event of a crash, the journal can be replayed, bringing both data and
|
||||||
metadata into a consistent state. This mode is the slowest except when data
|
metadata into a consistent state. This mode is the slowest except when data
|
||||||
needs to be read from and written to disk at the same time where it
|
needs to be read from and written to disk at the same time where it
|
||||||
outperforms all others modes. Curently ext4 does not have delayed
|
outperforms all others modes. Currently ext4 does not have delayed
|
||||||
allocation support if this data journalling mode is selected.
|
allocation support if this data journalling mode is selected.
|
||||||
|
|
||||||
References
|
References
|
||||||
|
|||||||
@@ -204,7 +204,7 @@ fiemap_check_flags() helper:
|
|||||||
|
|
||||||
int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
|
int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
|
||||||
|
|
||||||
The struct fieinfo should be passed in as recieved from ioctl_fiemap(). The
|
The struct fieinfo should be passed in as received from ioctl_fiemap(). The
|
||||||
set of fiemap flags which the fs understands should be passed via fs_flags. If
|
set of fiemap flags which the fs understands should be passed via fs_flags. If
|
||||||
fiemap_check_flags finds invalid user flags, it will place the bad values in
|
fiemap_check_flags finds invalid user flags, it will place the bad values in
|
||||||
fieinfo->fi_flags and return -EBADR. If the file system gets -EBADR, from
|
fieinfo->fi_flags and return -EBADR. If the file system gets -EBADR, from
|
||||||
|
|||||||
@@ -100,7 +100,7 @@ Installation
|
|||||||
$ sudo cp utils/mount/mount.nfs /sbin/mount.nfs
|
$ sudo cp utils/mount/mount.nfs /sbin/mount.nfs
|
||||||
|
|
||||||
In this location, mount.nfs will be invoked automatically for NFS mounts
|
In this location, mount.nfs will be invoked automatically for NFS mounts
|
||||||
by the system mount commmand.
|
by the system mount command.
|
||||||
|
|
||||||
NOTE: mount.nfs and therefore nfs-utils-1.1.2 or greater is only needed
|
NOTE: mount.nfs and therefore nfs-utils-1.1.2 or greater is only needed
|
||||||
on the NFS client machine. You do not need this specific version of
|
on the NFS client machine. You do not need this specific version of
|
||||||
|
|||||||
@@ -366,7 +366,7 @@ just those considered 'most important'. The new vectors are:
|
|||||||
RES, CAL, TLB -- rescheduling, call and TLB flush interrupts are
|
RES, CAL, TLB -- rescheduling, call and TLB flush interrupts are
|
||||||
sent from one CPU to another per the needs of the OS. Typically,
|
sent from one CPU to another per the needs of the OS. Typically,
|
||||||
their statistics are used by kernel developers and interested users to
|
their statistics are used by kernel developers and interested users to
|
||||||
determine the occurance of interrupt of the given type.
|
determine the occurrence of interrupts of the given type.
|
||||||
|
|
||||||
The above IRQ vectors are displayed only when relevent. For example,
|
The above IRQ vectors are displayed only when relevent. For example,
|
||||||
the threshold vector does not exist on x86_64 platforms. Others are
|
the threshold vector does not exist on x86_64 platforms. Others are
|
||||||
@@ -551,7 +551,7 @@ Committed_AS: The amount of memory presently allocated on the system.
|
|||||||
memory once that memory has been successfully allocated.
|
memory once that memory has been successfully allocated.
|
||||||
VmallocTotal: total size of vmalloc memory area
|
VmallocTotal: total size of vmalloc memory area
|
||||||
VmallocUsed: amount of vmalloc area which is used
|
VmallocUsed: amount of vmalloc area which is used
|
||||||
VmallocChunk: largest contigious block of vmalloc area which is free
|
VmallocChunk: largest contiguous block of vmalloc area which is free
|
||||||
|
|
||||||
..............................................................................
|
..............................................................................
|
||||||
|
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ The 'rom' file is special in that it provides read-only access to the device's
|
|||||||
ROM file, if available. It's disabled by default, however, so applications
|
ROM file, if available. It's disabled by default, however, so applications
|
||||||
should write the string "1" to the file to enable it before attempting a read
|
should write the string "1" to the file to enable it before attempting a read
|
||||||
call, and disable it following the access by writing "0" to the file. Note
|
call, and disable it following the access by writing "0" to the file. Note
|
||||||
that the device must be enabled for a rom read to return data succesfully.
|
that the device must be enabled for a rom read to return data successfully.
|
||||||
In the event a driver is not bound to the device, it can be enabled using the
|
In the event a driver is not bound to the device, it can be enabled using the
|
||||||
'enable' file, documented above.
|
'enable' file, documented above.
|
||||||
|
|
||||||
|
|||||||
@@ -124,10 +124,10 @@ sys_immutable -- If set, ATTR_SYS attribute on FAT is handled as
|
|||||||
flush -- If set, the filesystem will try to flush to disk more
|
flush -- If set, the filesystem will try to flush to disk more
|
||||||
early than normal. Not set by default.
|
early than normal. Not set by default.
|
||||||
|
|
||||||
rodir -- FAT has the ATTR_RO (read-only) attribute. But on Windows,
|
rodir -- FAT has the ATTR_RO (read-only) attribute. On Windows,
|
||||||
the ATTR_RO of the directory will be just ignored actually,
|
the ATTR_RO of the directory will just be ignored,
|
||||||
and is used by only applications as flag. E.g. it's setted
|
and is used only by applications as a flag (e.g. it's set
|
||||||
for the customized folder.
|
for the customized folder).
|
||||||
|
|
||||||
If you want to use ATTR_RO as read-only flag even for
|
If you want to use ATTR_RO as read-only flag even for
|
||||||
the directory, set this option.
|
the directory, set this option.
|
||||||
|
|||||||
@@ -458,7 +458,7 @@ debugfs interface, since it provides control over GPIO direction and
|
|||||||
value instead of just showing a gpio state summary. Plus, it could be
|
value instead of just showing a gpio state summary. Plus, it could be
|
||||||
present on production systems without debugging support.
|
present on production systems without debugging support.
|
||||||
|
|
||||||
Given approprate hardware documentation for the system, userspace could
|
Given appropriate hardware documentation for the system, userspace could
|
||||||
know for example that GPIO #23 controls the write protect line used to
|
know for example that GPIO #23 controls the write protect line used to
|
||||||
protect boot loader segments in flash memory. System upgrade procedures
|
protect boot loader segments in flash memory. System upgrade procedures
|
||||||
may need to temporarily remove that protection, first importing a GPIO,
|
may need to temporarily remove that protection, first importing a GPIO,
|
||||||
|
|||||||
@@ -108,7 +108,7 @@ There are two possible methods of using Kdump.
|
|||||||
|
|
||||||
2) Or use the system kernel binary itself as dump-capture kernel and there is
|
2) Or use the system kernel binary itself as dump-capture kernel and there is
|
||||||
no need to build a separate dump-capture kernel. This is possible
|
no need to build a separate dump-capture kernel. This is possible
|
||||||
only with the architecutres which support a relocatable kernel. As
|
only with the architectures which support a relocatable kernel. As
|
||||||
of today, i386, x86_64, ppc64 and ia64 architectures support relocatable
|
of today, i386, x86_64, ppc64 and ia64 architectures support relocatable
|
||||||
kernel.
|
kernel.
|
||||||
|
|
||||||
@@ -222,7 +222,7 @@ Dump-capture kernel config options (Arch Dependent, ia64)
|
|||||||
----------------------------------------------------------
|
----------------------------------------------------------
|
||||||
|
|
||||||
- No specific options are required to create a dump-capture kernel
|
- No specific options are required to create a dump-capture kernel
|
||||||
for ia64, other than those specified in the arch idependent section
|
for ia64, other than those specified in the arch independent section
|
||||||
above. This means that it is possible to use the system kernel
|
above. This means that it is possible to use the system kernel
|
||||||
as a dump-capture kernel if desired.
|
as a dump-capture kernel if desired.
|
||||||
|
|
||||||
|
|||||||
@@ -1076,7 +1076,7 @@ and is between 256 and 4096 characters. It is defined in the file
|
|||||||
|
|
||||||
kgdboc= [HW] kgdb over consoles.
|
kgdboc= [HW] kgdb over consoles.
|
||||||
Requires a tty driver that supports console polling.
|
Requires a tty driver that supports console polling.
|
||||||
(only serial suported for now)
|
(only serial supported for now)
|
||||||
Format: <serial_device>[,baud]
|
Format: <serial_device>[,baud]
|
||||||
|
|
||||||
kmac= [MIPS] korina ethernet MAC address.
|
kmac= [MIPS] korina ethernet MAC address.
|
||||||
@@ -1405,7 +1405,7 @@ and is between 256 and 4096 characters. It is defined in the file
|
|||||||
('y', default) or cooked coordinates ('n')
|
('y', default) or cooked coordinates ('n')
|
||||||
|
|
||||||
mtrr_chunk_size=nn[KMG] [X86]
|
mtrr_chunk_size=nn[KMG] [X86]
|
||||||
used for mtrr cleanup. It is largest continous chunk
|
used for mtrr cleanup. It is largest continuous chunk
|
||||||
that could hold holes aka. UC entries.
|
that could hold holes aka. UC entries.
|
||||||
|
|
||||||
mtrr_gran_size=nn[KMG] [X86]
|
mtrr_gran_size=nn[KMG] [X86]
|
||||||
|
|||||||
@@ -132,7 +132,7 @@ kobject_name():
|
|||||||
const char *kobject_name(const struct kobject * kobj);
|
const char *kobject_name(const struct kobject * kobj);
|
||||||
|
|
||||||
There is a helper function to both initialize and add the kobject to the
|
There is a helper function to both initialize and add the kobject to the
|
||||||
kernel at the same time, called supprisingly enough kobject_init_and_add():
|
kernel at the same time, called surprisingly enough kobject_init_and_add():
|
||||||
|
|
||||||
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
|
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
|
||||||
struct kobject *parent, const char *fmt, ...);
|
struct kobject *parent, const char *fmt, ...);
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user