linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] docs: kernel-parameters.txt: Fix whitespace
@ 2018-04-16 21:49 Thymo van Beers
  2018-04-16 22:03 ` Randy Dunlap
  0 siblings, 1 reply; 4+ messages in thread
From: Thymo van Beers @ 2018-04-16 21:49 UTC (permalink / raw)
  To: corbet; +Cc: linux-doc, linux-kernel

Some lines used spaces instead of tabs at line start.
This can cause mangled lines in editors due to inconsistency.

Replace spaces for tabs where appropriate.

Signed-off-by: Thymo van Beers <thymovanbeers@gmail.com>
---
Changes in v2:
  - Rebase against docs-next
  - Fix indentation modifications

 Documentation/admin-guide/kernel-parameters.txt | 136 ++++++++++++------------
 1 file changed, 68 insertions(+), 68 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 3487be79847c..f625f65c286f 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -106,11 +106,11 @@
 			use by PCI
 			Format: <irq>,<irq>...
 
-	acpi_mask_gpe=  [HW,ACPI]
+	acpi_mask_gpe=	[HW,ACPI]
 			Due to the existence of _Lxx/_Exx, some GPEs triggered
 			by unsupported hardware/firmware features can result in
-                        GPE floodings that cannot be automatically disabled by
-                        the GPE dispatcher.
+			GPE floodings that cannot be automatically disabled by
+			the GPE dispatcher.
 			This facility can be used to prevent such uncontrolled
 			GPE floodings.
 			Format: <int>
@@ -472,10 +472,10 @@
 			for platform specific values (SB1, Loongson3 and
 			others).
 
-	ccw_timeout_log [S390]
+	ccw_timeout_log	[S390]
 			See Documentation/s390/CommonIO for details.
 
-	cgroup_disable= [KNL] Disable a particular controller
+	cgroup_disable=	[KNL] Disable a particular controller
 			Format: {name of the controller(s) to disable}
 			The effects of cgroup_disable=foo are:
 			- foo isn't auto-mounted if you mount all cgroups in
@@ -641,8 +641,8 @@
 		hvc<n>	Use the hypervisor console device <n>. This is for
 			both Xen and PowerPC hypervisors.
 
-                If the device connected to the port is not a TTY but a braille
-                device, prepend "brl," before the device type, for instance
+		If the device connected to the port is not a TTY but a braille
+		device, prepend "brl," before the device type, for instance
 			console=brl,ttyS0
 		For now, only VisioBraille is supported.
 
@@ -662,7 +662,7 @@
 
 	consoleblank=	[KNL] The console blank (screen saver) timeout in
 			seconds. A value of 0 disables the blank timer.
-                       Defaults to 0.
+			Defaults to 0.
 
 	coredump_filter=
 			[KNL] Change the default value for
@@ -730,7 +730,7 @@
 			or memory reserved is below 4G.
 
 	cryptomgr.notests
-                        [KNL] Disable crypto self-tests
+			[KNL] Disable crypto self-tests
 
 	cs89x0_dma=	[HW,NET]
 			Format: <dma>
@@ -746,7 +746,7 @@
 			Format: <port#>,<type>
 			See also Documentation/input/devices/joystick-parport.rst
 
-	ddebug_query=   [KNL,DYNAMIC_DEBUG] Enable debug messages at early boot
+	ddebug_query=	[KNL,DYNAMIC_DEBUG] Enable debug messages at early boot
 			time. See
 			Documentation/admin-guide/dynamic-debug-howto.rst for
 			details.  Deprecated, see dyndbg.
@@ -833,7 +833,7 @@
 			causing system reset or hang due to sending
 			INIT from AP to BSP.
 
-	disable_ddw     [PPC/PSERIES]
+	disable_ddw	[PPC/PSERIES]
 			Disable Dynamic DMA Window support. Use this if
 			to workaround buggy firmware.
 
@@ -1188,7 +1188,7 @@
 			parameter will force ia64_sal_cache_flush to call
 			ia64_pal_cache_flush instead of SAL_CACHE_FLUSH.
 
-	forcepae [X86-32]
+	forcepae	[X86-32]
 			Forcefully enable Physical Address Extension (PAE).
 			Many Pentium M systems disable PAE but may have a
 			functionally usable PAE implementation.
@@ -1247,7 +1247,7 @@
 
 	gamma=		[HW,DRM]
 
-	gart_fix_e820=  [X86_64] disable the fix e820 for K8 GART
+	gart_fix_e820=	[X86_64] disable the fix e820 for K8 GART
 			Format: off | on
 			default: on
 
@@ -1341,11 +1341,11 @@
 			x86-64 are 2M (when the CPU supports "pse") and 1G
 			(when the CPU supports the "pdpe1gb" cpuinfo flag).
 
-	hvc_iucv=	[S390] Number of z/VM IUCV hypervisor console (HVC)
-			       terminal devices. Valid values: 0..8
-	hvc_iucv_allow=	[S390] Comma-separated list of z/VM user IDs.
-			       If specified, z/VM IUCV HVC accepts connections
-			       from listed z/VM user IDs only.
+	hvc_iucv=	[S390]	Number of z/VM IUCV hypervisor console (HVC)
+				terminal devices. Valid values: 0..8
+	hvc_iucv_allow=	[S390]	Comma-separated list of z/VM user IDs.
+				If specified, z/VM IUCV HVC accepts connections
+				from listed z/VM user IDs only.
 
 	keep_bootcon	[KNL]
 			Do not unregister boot console at start. This is only
@@ -1353,11 +1353,11 @@
 			between unregistering the boot console and initializing
 			the real console.
 
-	i2c_bus=	[HW] Override the default board specific I2C bus speed
-			     or register an additional I2C bus that is not
-			     registered from board initialization code.
-			     Format:
-			     <bus_id>,<clkrate>
+	i2c_bus=	[HW]	Override the default board specific I2C bus speed
+				or register an additional I2C bus that is not
+				registered from board initialization code.
+				Format:
+				<bus_id>,<clkrate>
 
 	i8042.debug	[HW] Toggle i8042 debug mode
 	i8042.unmask_kbd_data
@@ -1386,7 +1386,7 @@
 			Default: only on s2r transitions on x86; most other
 			architectures force reset to be always executed
 	i8042.unlock	[HW] Unlock (ignore) the keylock
-	i8042.kbdreset  [HW] Reset device connected to KBD port
+	i8042.kbdreset	[HW] Reset device connected to KBD port
 
 	i810=		[HW,DRM]
 
@@ -1548,13 +1548,13 @@
 			programs exec'd, files mmap'd for exec, and all files
 			opened for read by uid=0.
 
-	ima_template=   [IMA]
+	ima_template=	[IMA]
 			Select one of defined IMA measurements template formats.
 			Formats: { "ima" | "ima-ng" | "ima-sig" }
 			Default: "ima-ng"
 
 	ima_template_fmt=
-	                [IMA] Define a custom template format.
+			[IMA] Define a custom template format.
 			Format: { "field1|...|fieldN" }
 
 	ima.ahash_minsize= [IMA] Minimum file size for asynchronous hash usage
@@ -1597,7 +1597,7 @@
 	inport.irq=	[HW] Inport (ATI XL and Microsoft) busmouse driver
 			Format: <irq>
 
-	int_pln_enable  [x86] Enable power limit notification interrupt
+	int_pln_enable	[x86] Enable power limit notification interrupt
 
 	integrity_audit=[IMA]
 			Format: { "0" | "1" }
@@ -1650,39 +1650,39 @@
 			0	disables intel_idle and fall back on acpi_idle.
 			1 to 9	specify maximum depth of C-state.
 
-	intel_pstate=  [X86]
-		       disable
-		         Do not enable intel_pstate as the default
-		         scaling driver for the supported processors
-		       passive
-			 Use intel_pstate as a scaling driver, but configure it
-			 to work with generic cpufreq governors (instead of
-			 enabling its internal governor).  This mode cannot be
-			 used along with the hardware-managed P-states (HWP)
-			 feature.
-		       force
-			 Enable intel_pstate on systems that prohibit it by default
-			 in favor of acpi-cpufreq. Forcing the intel_pstate driver
-			 instead of acpi-cpufreq may disable platform features, such
-			 as thermal controls and power capping, that rely on ACPI
-			 P-States information being indicated to OSPM and therefore
-			 should be used with caution. This option does not work with
-			 processors that aren't supported by the intel_pstate driver
-			 or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
-		       no_hwp
-		         Do not enable hardware P state control (HWP)
-			 if available.
-		hwp_only
-			Only load intel_pstate on systems which support
-			hardware P state control (HWP) if available.
-		support_acpi_ppc
-			Enforce ACPI _PPC performance limits. If the Fixed ACPI
-			Description Table, specifies preferred power management
-			profile as "Enterprise Server" or "Performance Server",
-			then this feature is turned on by default.
-		per_cpu_perf_limits
-			Allow per-logical-CPU P-State performance control limits using
-			cpufreq sysfs interface
+	intel_pstate=	[X86]
+			disable
+				Do not enable intel_pstate as the default
+				scaling driver for the supported processors
+			passive
+				Use intel_pstate as a scaling driver, but configure it
+				to work with generic cpufreq governors (instead of
+				enabling its internal governor).  This mode cannot be
+				used along with the hardware-managed P-states (HWP)
+				feature.
+			force
+				Enable intel_pstate on systems that prohibit it by default
+				in favor of acpi-cpufreq. Forcing the intel_pstate driver
+				instead of acpi-cpufreq may disable platform features, such
+				as thermal controls and power capping, that rely on ACPI
+				P-States information being indicated to OSPM and therefore
+				should be used with caution. This option does not work with
+				processors that aren't supported by the intel_pstate driver
+				or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
+			no_hwp
+				Do not enable hardware P state control (HWP)
+				if available.
+			hwp_only
+				Only load intel_pstate on systems which support
+				hardware P state control (HWP) if available.
+			support_acpi_ppc
+				Enforce ACPI _PPC performance limits. If the Fixed ACPI
+				Description Table, specifies preferred power management
+				profile as "Enterprise Server" or "Performance Server",
+				then this feature is turned on by default.
+			per_cpu_perf_limits
+				Allow per-logical-CPU P-State performance control limits using
+				cpufreq sysfs interface
 
 	intremap=	[X86-64, Intel-IOMMU]
 			on	enable Interrupt Remapping (default)
@@ -2027,7 +2027,7 @@
 			* [no]ncqtrim: Turn off queued DSM TRIM.
 
 			* nohrst, nosrst, norst: suppress hard, soft
-                          and both resets.
+			and both resets.
 
 			* rstonce: only attempt one reset during
 			  hot-unplug link recovery
@@ -2215,7 +2215,7 @@
 			[KNL,SH] Allow user to override the default size for
 			per-device physically contiguous DMA buffers.
 
-        memhp_default_state=online/offline
+	memhp_default_state=online/offline
 			[KNL] Set the initial state for the memory hotplug
 			onlining policy. If not specified, the default value is
 			set according to the
@@ -2762,7 +2762,7 @@
 			[X86,PV_OPS] Disable paravirtualized VMware scheduler
 			clock and use the default one.
 
-	no-steal-acc    [X86,KVM] Disable paravirtualized steal time accounting.
+	no-steal-acc	[X86,KVM] Disable paravirtualized steal time accounting.
 			steal time is computed, but won't influence scheduler
 			behaviour
 
@@ -2823,7 +2823,7 @@
 	notsc		[BUGS=X86-32] Disable Time Stamp Counter
 
 	nowatchdog	[KNL] Disable both lockup detectors, i.e.
-                        soft-lockup and NMI watchdog (hard-lockup).
+			soft-lockup and NMI watchdog (hard-lockup).
 
 	nowb		[ARM]
 
@@ -2843,7 +2843,7 @@
 			If the dependencies are under your control, you can
 			turn on cpu0_hotplug.
 
-	nps_mtm_hs_ctr= [KNL,ARC]
+	nps_mtm_hs_ctr=	[KNL,ARC]
 			This parameter sets the maximum duration, in
 			cycles, each HW thread of the CTOP can run
 			without interruptions, before HW switches it.
@@ -2984,7 +2984,7 @@
 
 	pci=option[,option...]	[PCI] various PCI subsystem options:
 		earlydump	[X86] dump PCI config space before the kernel
-			        changes anything
+				changes anything
 		off		[X86] don't probe for the PCI bus
 		bios		[X86-32] force use of PCI BIOS, don't access
 				the hardware directly. Use this if your machine
@@ -3072,7 +3072,7 @@
 				is enabled by default.  If you need to use this,
 				please report a bug.
 		nocrs		[X86] Ignore PCI host bridge windows from ACPI.
-			        If you need to use this, please report a bug.
+				If you need to use this, please report a bug.
 		routeirq	Do IRQ routing for all PCI devices.
 				This is normally done in pci_enable_device(),
 				so this option is a temporary workaround
@@ -4391,7 +4391,7 @@
 
 	usbcore.initial_descriptor_timeout=
 			[USB] Specifies timeout for the initial 64-byte
-                        USB_REQ_GET_DESCRIPTOR request in milliseconds
+			USB_REQ_GET_DESCRIPTOR request in milliseconds
 			(default 5000 = 5.0 seconds).
 
 	usbcore.nousb	[USB] Disable the USB subsystem
-- 
2.16.1

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH v2] docs: kernel-parameters.txt: Fix whitespace
  2018-04-16 21:49 [PATCH v2] docs: kernel-parameters.txt: Fix whitespace Thymo van Beers
@ 2018-04-16 22:03 ` Randy Dunlap
  2018-04-18 18:16   ` Thymo van Beers
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2018-04-16 22:03 UTC (permalink / raw)
  To: Thymo van Beers, corbet; +Cc: linux-doc, linux-kernel

On 04/16/18 14:49, Thymo van Beers wrote:
> Some lines used spaces instead of tabs at line start.
> This can cause mangled lines in editors due to inconsistency.
> 
> Replace spaces for tabs where appropriate.
> 
> Signed-off-by: Thymo van Beers <thymovanbeers@gmail.com>
> ---
> Changes in v2:
>   - Rebase against docs-next
>   - Fix indentation modifications
> 
>  Documentation/admin-guide/kernel-parameters.txt | 136 ++++++++++++------------
>  1 file changed, 68 insertions(+), 68 deletions(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 3487be79847c..f625f65c286f 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt

Most of the patch is OK IMO, but not the intel_pstate part:
The 2-space extra indents work fine here, while the extra tab makes a lot of the
lines go beyond the 80-column mark.

> @@ -1650,39 +1650,39 @@
>  			0	disables intel_idle and fall back on acpi_idle.
>  			1 to 9	specify maximum depth of C-state.
>  
> -	intel_pstate=  [X86]
> -		       disable
> -		         Do not enable intel_pstate as the default
> -		         scaling driver for the supported processors
> -		       passive
> -			 Use intel_pstate as a scaling driver, but configure it
> -			 to work with generic cpufreq governors (instead of
> -			 enabling its internal governor).  This mode cannot be
> -			 used along with the hardware-managed P-states (HWP)
> -			 feature.
> -		       force
> -			 Enable intel_pstate on systems that prohibit it by default
> -			 in favor of acpi-cpufreq. Forcing the intel_pstate driver
> -			 instead of acpi-cpufreq may disable platform features, such
> -			 as thermal controls and power capping, that rely on ACPI
> -			 P-States information being indicated to OSPM and therefore
> -			 should be used with caution. This option does not work with
> -			 processors that aren't supported by the intel_pstate driver
> -			 or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
> -		       no_hwp
> -		         Do not enable hardware P state control (HWP)
> -			 if available.
> -		hwp_only
> -			Only load intel_pstate on systems which support
> -			hardware P state control (HWP) if available.
> -		support_acpi_ppc
> -			Enforce ACPI _PPC performance limits. If the Fixed ACPI
> -			Description Table, specifies preferred power management
> -			profile as "Enterprise Server" or "Performance Server",
> -			then this feature is turned on by default.
> -		per_cpu_perf_limits
> -			Allow per-logical-CPU P-State performance control limits using
> -			cpufreq sysfs interface
> +	intel_pstate=	[X86]
> +			disable
> +				Do not enable intel_pstate as the default
> +				scaling driver for the supported processors
> +			passive
> +				Use intel_pstate as a scaling driver, but configure it
> +				to work with generic cpufreq governors (instead of
> +				enabling its internal governor).  This mode cannot be
> +				used along with the hardware-managed P-states (HWP)
> +				feature.
> +			force
> +				Enable intel_pstate on systems that prohibit it by default
> +				in favor of acpi-cpufreq. Forcing the intel_pstate driver
> +				instead of acpi-cpufreq may disable platform features, such
> +				as thermal controls and power capping, that rely on ACPI
> +				P-States information being indicated to OSPM and therefore
> +				should be used with caution. This option does not work with
> +				processors that aren't supported by the intel_pstate driver
> +				or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
> +			no_hwp
> +				Do not enable hardware P state control (HWP)
> +				if available.
> +			hwp_only
> +				Only load intel_pstate on systems which support
> +				hardware P state control (HWP) if available.
> +			support_acpi_ppc
> +				Enforce ACPI _PPC performance limits. If the Fixed ACPI
> +				Description Table, specifies preferred power management
> +				profile as "Enterprise Server" or "Performance Server",
> +				then this feature is turned on by default.
> +			per_cpu_perf_limits
> +				Allow per-logical-CPU P-State performance control limits using
> +				cpufreq sysfs interface
>  
>  	intremap=	[X86-64, Intel-IOMMU]
>  			on	enable Interrupt Remapping (default)
> @@ -2027,7 +2027,7 @@
>  			* [no]ncqtrim: Turn off queued DSM TRIM.
>  
>  			* nohrst, nosrst, norst: suppress hard, soft
> -                          and both resets.
> +			and both resets.

I would leave that line above indented like the one after "rstonce" below.

>  
>  			* rstonce: only attempt one reset during
>  			  hot-unplug link recovery


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2] docs: kernel-parameters.txt: Fix whitespace
  2018-04-16 22:03 ` Randy Dunlap
@ 2018-04-18 18:16   ` Thymo van Beers
  2018-04-18 18:32     ` Randy Dunlap
  0 siblings, 1 reply; 4+ messages in thread
From: Thymo van Beers @ 2018-04-18 18:16 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-doc, linux-kernel

On Mon, Apr 16, 2018 at 03:03:47PM -0700, Randy Dunlap wrote:
> On 04/16/18 14:49, Thymo van Beers wrote:
> > Some lines used spaces instead of tabs at line start.
> > This can cause mangled lines in editors due to inconsistency.
> > 
> > Replace spaces for tabs where appropriate.
> > 
> > Signed-off-by: Thymo van Beers <thymovanbeers@gmail.com>
> > ---
> > Changes in v2:
> >   - Rebase against docs-next
> >   - Fix indentation modifications
> > 
> >  Documentation/admin-guide/kernel-parameters.txt | 136 ++++++++++++------------
> >  1 file changed, 68 insertions(+), 68 deletions(-)
> > 
> > diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> > index 3487be79847c..f625f65c286f 100644
> > --- a/Documentation/admin-guide/kernel-parameters.txt
> > +++ b/Documentation/admin-guide/kernel-parameters.txt
> 
> Most of the patch is OK IMO, but not the intel_pstate part:
> The 2-space extra indents work fine here, while the extra tab makes a lot of the
> lines go beyond the 80-column mark.
> 
> > @@ -1650,39 +1650,39 @@
> >  			0	disables intel_idle and fall back on acpi_idle.
> >  			1 to 9	specify maximum depth of C-state.
> >  
> > -	intel_pstate=  [X86]
> > -		       disable
> > -		         Do not enable intel_pstate as the default
> > -		         scaling driver for the supported processors
> > -		       passive
> > -			 Use intel_pstate as a scaling driver, but configure it
> > -			 to work with generic cpufreq governors (instead of
> > -			 enabling its internal governor).  This mode cannot be
> > -			 used along with the hardware-managed P-states (HWP)
> > -			 feature.
> > -		       force
> > -			 Enable intel_pstate on systems that prohibit it by default
> > -			 in favor of acpi-cpufreq. Forcing the intel_pstate driver
> > -			 instead of acpi-cpufreq may disable platform features, such
> > -			 as thermal controls and power capping, that rely on ACPI
> > -			 P-States information being indicated to OSPM and therefore
> > -			 should be used with caution. This option does not work with
> > -			 processors that aren't supported by the intel_pstate driver
> > -			 or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
> > -		       no_hwp
> > -		         Do not enable hardware P state control (HWP)
> > -			 if available.
> > -		hwp_only
> > -			Only load intel_pstate on systems which support
> > -			hardware P state control (HWP) if available.
> > -		support_acpi_ppc
> > -			Enforce ACPI _PPC performance limits. If the Fixed ACPI
> > -			Description Table, specifies preferred power management
> > -			profile as "Enterprise Server" or "Performance Server",
> > -			then this feature is turned on by default.
> > -		per_cpu_perf_limits
> > -			Allow per-logical-CPU P-State performance control limits using
> > -			cpufreq sysfs interface
> > +	intel_pstate=	[X86]
> > +			disable
> > +				Do not enable intel_pstate as the default
> > +				scaling driver for the supported processors
> > +			passive
> > +				Use intel_pstate as a scaling driver, but configure it
> > +				to work with generic cpufreq governors (instead of
> > +				enabling its internal governor).  This mode cannot be
> > +				used along with the hardware-managed P-states (HWP)
> > +				feature.
> > +			force
> > +				Enable intel_pstate on systems that prohibit it by default
> > +				in favor of acpi-cpufreq. Forcing the intel_pstate driver
> > +				instead of acpi-cpufreq may disable platform features, such
> > +				as thermal controls and power capping, that rely on ACPI
> > +				P-States information being indicated to OSPM and therefore
> > +				should be used with caution. This option does not work with
> > +				processors that aren't supported by the intel_pstate driver
> > +				or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
> > +			no_hwp
> > +				Do not enable hardware P state control (HWP)
> > +				if available.
> > +			hwp_only
> > +				Only load intel_pstate on systems which support
> > +				hardware P state control (HWP) if available.
> > +			support_acpi_ppc
> > +				Enforce ACPI _PPC performance limits. If the Fixed ACPI
> > +				Description Table, specifies preferred power management
> > +				profile as "Enterprise Server" or "Performance Server",
> > +				then this feature is turned on by default.
> > +			per_cpu_perf_limits
> > +				Allow per-logical-CPU P-State performance control limits using
> > +				cpufreq sysfs interface
> >  
> >  	intremap=	[X86-64, Intel-IOMMU]
> >  			on	enable Interrupt Remapping (default)
> > @@ -2027,7 +2027,7 @@
> >  			* [no]ncqtrim: Turn off queued DSM TRIM.
> >  
> >  			* nohrst, nosrst, norst: suppress hard, soft
> > -                          and both resets.
> > +			and both resets.
> 
> I would leave that line above indented like the one after "rstonce" below.
> 
> >  
> >  			* rstonce: only attempt one reset during
> >  			  hot-unplug link recovery
> 
> 
> -- 
> ~Randy

Okay, thanks for your feedback.

I reindented intel_pstate as you said and I can still see the whole
description for the 'advanced' option is going past the 80-column mark.

I'll leave it indented with two spaces for this patch.
If you wish I can make a separate patch that addresses 80-column overrun
for intel_pstate.

I'll indent the nohrst,... section like rstonce.

Does that sound good to you?

-Thymo
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2] docs: kernel-parameters.txt: Fix whitespace
  2018-04-18 18:16   ` Thymo van Beers
@ 2018-04-18 18:32     ` Randy Dunlap
  0 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2018-04-18 18:32 UTC (permalink / raw)
  To: Thymo van Beers; +Cc: linux-doc, linux-kernel

On 04/18/18 11:16, Thymo van Beers wrote:
> On Mon, Apr 16, 2018 at 03:03:47PM -0700, Randy Dunlap wrote:
>> On 04/16/18 14:49, Thymo van Beers wrote:
>>> Some lines used spaces instead of tabs at line start.
>>> This can cause mangled lines in editors due to inconsistency.
>>>
>>> Replace spaces for tabs where appropriate.
>>>
>>> Signed-off-by: Thymo van Beers <thymovanbeers@gmail.com>
>>> ---
>>> Changes in v2:
>>>   - Rebase against docs-next
>>>   - Fix indentation modifications
>>>
>>>  Documentation/admin-guide/kernel-parameters.txt | 136 ++++++++++++------------
>>>  1 file changed, 68 insertions(+), 68 deletions(-)
>>>
>>> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
>>> index 3487be79847c..f625f65c286f 100644
>>> --- a/Documentation/admin-guide/kernel-parameters.txt
>>> +++ b/Documentation/admin-guide/kernel-parameters.txt
>>
>> Most of the patch is OK IMO, but not the intel_pstate part:
>> The 2-space extra indents work fine here, while the extra tab makes a lot of the
>> lines go beyond the 80-column mark.
>>
>>> @@ -1650,39 +1650,39 @@
>>>  			0	disables intel_idle and fall back on acpi_idle.
>>>  			1 to 9	specify maximum depth of C-state.
>>>  
>>> -	intel_pstate=  [X86]
>>> -		       disable
>>> -		         Do not enable intel_pstate as the default
>>> -		         scaling driver for the supported processors
>>> -		       passive
>>> -			 Use intel_pstate as a scaling driver, but configure it
>>> -			 to work with generic cpufreq governors (instead of
>>> -			 enabling its internal governor).  This mode cannot be
>>> -			 used along with the hardware-managed P-states (HWP)
>>> -			 feature.
>>> -		       force
>>> -			 Enable intel_pstate on systems that prohibit it by default
>>> -			 in favor of acpi-cpufreq. Forcing the intel_pstate driver
>>> -			 instead of acpi-cpufreq may disable platform features, such
>>> -			 as thermal controls and power capping, that rely on ACPI
>>> -			 P-States information being indicated to OSPM and therefore
>>> -			 should be used with caution. This option does not work with
>>> -			 processors that aren't supported by the intel_pstate driver
>>> -			 or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
>>> -		       no_hwp
>>> -		         Do not enable hardware P state control (HWP)
>>> -			 if available.
>>> -		hwp_only
>>> -			Only load intel_pstate on systems which support
>>> -			hardware P state control (HWP) if available.
>>> -		support_acpi_ppc
>>> -			Enforce ACPI _PPC performance limits. If the Fixed ACPI
>>> -			Description Table, specifies preferred power management
>>> -			profile as "Enterprise Server" or "Performance Server",
>>> -			then this feature is turned on by default.
>>> -		per_cpu_perf_limits
>>> -			Allow per-logical-CPU P-State performance control limits using
>>> -			cpufreq sysfs interface
>>> +	intel_pstate=	[X86]
>>> +			disable
>>> +				Do not enable intel_pstate as the default
>>> +				scaling driver for the supported processors
>>> +			passive
>>> +				Use intel_pstate as a scaling driver, but configure it
>>> +				to work with generic cpufreq governors (instead of
>>> +				enabling its internal governor).  This mode cannot be
>>> +				used along with the hardware-managed P-states (HWP)
>>> +				feature.
>>> +			force
>>> +				Enable intel_pstate on systems that prohibit it by default
>>> +				in favor of acpi-cpufreq. Forcing the intel_pstate driver
>>> +				instead of acpi-cpufreq may disable platform features, such
>>> +				as thermal controls and power capping, that rely on ACPI
>>> +				P-States information being indicated to OSPM and therefore
>>> +				should be used with caution. This option does not work with
>>> +				processors that aren't supported by the intel_pstate driver
>>> +				or on platforms that use pcc-cpufreq instead of acpi-cpufreq.
>>> +			no_hwp
>>> +				Do not enable hardware P state control (HWP)
>>> +				if available.
>>> +			hwp_only
>>> +				Only load intel_pstate on systems which support
>>> +				hardware P state control (HWP) if available.
>>> +			support_acpi_ppc
>>> +				Enforce ACPI _PPC performance limits. If the Fixed ACPI
>>> +				Description Table, specifies preferred power management
>>> +				profile as "Enterprise Server" or "Performance Server",
>>> +				then this feature is turned on by default.
>>> +			per_cpu_perf_limits
>>> +				Allow per-logical-CPU P-State performance control limits using
>>> +				cpufreq sysfs interface
>>>  
>>>  	intremap=	[X86-64, Intel-IOMMU]
>>>  			on	enable Interrupt Remapping (default)
>>> @@ -2027,7 +2027,7 @@
>>>  			* [no]ncqtrim: Turn off queued DSM TRIM.
>>>  
>>>  			* nohrst, nosrst, norst: suppress hard, soft
>>> -                          and both resets.
>>> +			and both resets.
>>
>> I would leave that line above indented like the one after "rstonce" below.
>>
>>>  
>>>  			* rstonce: only attempt one reset during
>>>  			  hot-unplug link recovery
>>
>>
>> -- 
>> ~Randy
> 
> Okay, thanks for your feedback.
> 
> I reindented intel_pstate as you said and I can still see the whole
> description for the 'advanced' option is going past the 80-column mark.
> 
> I'll leave it indented with two spaces for this patch.
> If you wish I can make a separate patch that addresses 80-column overrun
> for intel_pstate.
> 
> I'll indent the nohrst,... section like rstonce.
> 
> Does that sound good to you?

Yes, it does.  Go for it!

thanks,
-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2018-04-18 18:32 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-04-16 21:49 [PATCH v2] docs: kernel-parameters.txt: Fix whitespace Thymo van Beers
2018-04-16 22:03 ` Randy Dunlap
2018-04-18 18:16   ` Thymo van Beers
2018-04-18 18:32     ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).