[OpenWrt-Devel] [PATCH] [config] Various typo/grammar/line-length fixes in Config*.in files

Robert P. J. Day rpjday at crashcourse.ca
Tue Sep 9 08:20:07 EDT 2014


Non-functional changes to config/Config-*.in files, including:

* spelling mistakes
* inconsistent terminology
* grammar
* overly long lines in "help" components

Signed-off-by: Robert P. J. Day <rpjday at crashcourse.ca>

---

  while digging through the four existing Config*.in files to
understand the build structure, i started tweaking a number of
entries, for the most part to fix "help" information regarding things
like grammar, punctuation, using consistent terminology and, in many
cases, overly long lines, given that the standard is typically that
displayed config help should not exceed 80 characters to avoid
wrapping in a terminal window.

  these changes appear to make no difference in a build test i just
ran, and you're welcome to ignore them as unnecessary -- i figured
that, while i was there, i'd do some proofreading and editing.

diff --git a/config/Config-build.in b/config/Config-build.in
index 02fe136..89cf964 100644
--- a/config/Config-build.in
+++ b/config/Config-build.in
@@ -20,23 +20,25 @@ menu "Global build settings"
 		default y
 		bool "Compile with support for patented functionality"
 		help
-		  When this option is disabled, software which provides patented functionality will not be built.
-		  In case software provides optional support for patented functionality,
-		  this optional support will get disabled for this package.
+		  When this option is disabled, software which provides patented functionality
+		  will not be built.  In case software provides optional support for patented
+		  functionality, this optional support will get disabled for this package.

 	config BUILD_NLS
 		default n
 		bool "Compile with full language support"
 		help
-		  When this option is enabled, packages are built with the full versions of iconv and GNU gettext
-		  instead of the default OpenWrt stubs. If uClibc is used, it is also built with locale support.
+		  When this option is enabled, packages are built with the full versions of
+		  iconv and GNU gettext instead of the default OpenWrt stubs. If uClibc is
+		  used, it is also built with locale support.

 	config BUILD_STATIC_TOOLS
 		default n
 		bool "Attempt to link host utilities statically"
 		help
-		  Linking host utilities like sed or firmware-utils statically increases the portability of the
-		  generated ImageBuilder and SDK tarballs, however it may fail on some Linux distributions.
+		  Linking host utilities like sed or firmware-utils statically increases the
+		  portability of the generated ImageBuilder and SDK tarballs; however, it may
+		  fail on some Linux distributions.

 	config SHADOW_PASSWORDS
 		bool
@@ -50,7 +52,8 @@ menu "Global build settings"
 		prompt "Remove ipkg/opkg status data files in final images"
 		default n
 		help
-		  This removes all ipkg/opkg status data files from the target directory before building the root fs
+		  This removes all ipkg/opkg status data files from the target directory
+		  before building the root filesystem.

 	config COLLECT_KERNEL_DEBUG
 		bool
@@ -59,7 +62,8 @@ menu "Global build settings"
 		default n
 		help
 		  This collects debugging symbols from the kernel and all compiled modules.
-		  Useful for release builds, so that kernel issues can be debugged offline later.
+		  Useful for release builds, so that kernel issues can be debugged offline
+		  later.

 	comment "Kernel build options"

@@ -72,24 +76,24 @@ menu "Global build settings"
 		prompt "Compile packages with debugging info"
 		default n
 		help
-		  Adds -g3 to the CFLAGS
+		  Adds -g3 to the CFLAGS.

 	config IPV6
 		bool
 		prompt "Enable IPv6 support in packages"
 		default y
 		help
-		  Enable IPV6 support in packages (passes --enable-ipv6 to configure scripts).
+		  Enable IPv6 support in packages (passes --enable-ipv6 to configure scripts).

 	config PKG_BUILD_PARALLEL
 		bool
 		prompt "Compile certain packages parallelized"
 		default y
 		help
-		  This adds a -jX option to certain packages that are known to
-		  behave well for parallel build. By default the package make processes
-		  use the main jobserver, in which case this option only takes effect
-		  when you add -jX to the make command.
+		  This adds a -jX option to certain packages that are known to behave well
+		  for parallel build. By default, the package make processes use the main
+		  jobserver, in which case this option only takes effect when you add -jX
+		  to the make command.

 		  If you are unsure, select N.

@@ -98,9 +102,9 @@ menu "Global build settings"
 		prompt "Enable gcc format-security"
 		default n
 		help
-		  Add -Wformat -Werror=format-security to the CFLAGS
-		  You can disable this per package by adding
-		  PKG_CHECK_FORMAT_SECURITY:=0 in the package Makefile
+		  Add -Wformat -Werror=format-security to the CFLAGS.  You can disable
+		  this per package by adding PKG_CHECK_FORMAT_SECURITY:=0 in the package
+		  Makefile.

 	config PKG_BUILD_USE_JOBSERVER
 		bool
@@ -109,16 +113,15 @@ menu "Global build settings"
 		default y
 		help
 		  This passes the main make process jobserver fds to package builds,
-		  enabling full parallelization across different packages
+		  enabling full parallelization across different packages.

 		  Note that disabling this may overcommit CPU resources depending on the
-		  -j level of the main make process, the number of package
-		  submake jobs selected below and the number of actual CPUs present.
+		  -j level of the main make process, the number of package submake jobs
+		  selected below and the number of actual CPUs present.
 		  Example: If the main make is passed a -j4 and the submake -j
 		  is also set to 4, we may end up with 16 parallel make processes
 		  in the worst case.

-
 	config PKG_BUILD_JOBS
 		int
 		prompt "Number of package submake jobs (2-512)"
@@ -137,12 +140,12 @@ menu "Global build settings"
 		help
 		  Always set the default package build rules to parallel build.

-		  WARNING: This may break build or kill your cat, as it builds
-		  packages with multiple jobs that are probably not tested in
-		  a parallel build environment.
+		  WARNING: This may break build or kill your cat, as it builds packages
+		  with multiple jobs that are probably not tested in a parallel build
+		  environment.

-		  Only say Y, if you don't mind fixing broken packages.
-		  Before reporting build bugs, set this to N and re-run the build.
+		  Only say Y if you don't mind fixing broken packages.  Before reporting
+		  build bugs, set this to N and re-run the build.

 	comment "Stripping options"

@@ -157,12 +160,13 @@ menu "Global build settings"
 		config NO_STRIP
 			bool "none"
 			help
-			  This will install unstripped binaries (useful for native compiling/debugging)
+			  This will install unstripped binaries (useful for native
+		 	  compiling/debugging).

 		config USE_STRIP
 			bool "strip"
 			help
-			  This will install binaries stripped using strip from binutils
+			  This will install binaries stripped using strip from binutils.


 		config USE_SSTRIP
@@ -171,7 +175,7 @@ menu "Global build settings"
 			depends on !USE_GLIBC
 			depends on !USE_EGLIBC
 			help
-			  This will install binaries stripped using sstrip
+			  This will install binaries stripped using sstrip.
 	endchoice

 	config STRIP_ARGS
@@ -181,22 +185,22 @@ menu "Global build settings"
 		default "--strip-unneeded --remove-section=.comment --remove-section=.note" if DEBUG
 		default "--strip-all"
 		help
-		  Specifies arguments passed to the strip command when stripping binaries
+		  Specifies arguments passed to the strip command when stripping binaries.

 	config STRIP_KERNEL_EXPORTS
 		bool "Strip unnecessary exports from the kernel image"
 		help
-		  Reduces kernel size by stripping unused kernel exports from the kernel image
-		  Note that this might make the kernel incompatible with any kernel modules that
-		  were not selected at the time the kernel image was created
+		  Reduces kernel size by stripping unused kernel exports from the kernel
+		  image.  Note that this might make the kernel incompatible with any kernel
+		  modules that were not selected at the time the kernel image was created.

 	config USE_MKLIBS
 		bool "Strip unnecessary functions from libraries"
 		help
 		  Reduces libraries to only those functions that are necessary for using all
-		  selected packages (including those selected as <M>)
-		  Note that this will make the system libraries incompatible with most of the packages
-		  that are not selected during the build process
+		  selected packages (including those selected as <M>).  Note that this will
+		  make the system libraries incompatible with most of the packages that are
+		  not selected during the build process.

 	choice
 		prompt "Preferred standard C++ library"
diff --git a/config/Config-devel.in b/config/Config-devel.in
index 0931175..4d8d46b 100644
--- a/config/Config-devel.in
+++ b/config/Config-devel.in
@@ -28,26 +28,27 @@ menuconfig DEVEL
 		bool "Automatic rebuild of packages" if DEVEL
 		default y
 		help
-		  Automatically rebuild packages when their files change
+		  Automatically rebuild packages when their files change.

 	config BUILD_SUFFIX
 		string "Build suffix to append to the BUILD_DIR variable" if DEVEL
 		default ""
 		help
-		  Build suffix to append to the BUILD_DIR variable, i.e: build_dir_suffix
+		  Build suffix to append to the BUILD_DIR variable, i.e: build_dir_suffix.

 	config TARGET_ROOTFS_DIR
 		string "Override the default TARGET_ROOTFS_DIR variable" if DEVEL
 		default ""
 		help
-		  Override the default TARGET_ROOTFS_DIR variable content $(BUILD_DIR) with custom path.
-		  Use this option to re-define the location of the target root file system directory.
+		  Override the default TARGET_ROOTFS_DIR variable content $(BUILD_DIR) with
+		  custom path.  Use this option to re-define the location of the target
+		  root filesystem directory.

 	config CCACHE
 		bool "Use ccache" if DEVEL
 		default n
 		help
-		  Compiler cache; see http://ccache.samba.org/
+		  Compiler cache; see http://ccache.samba.org/.

 	config EXTERNAL_KERNEL_TREE
 		string "Use external kernel tree" if DEVEL
@@ -59,8 +60,7 @@ menuconfig DEVEL
 		help
 		  Enter the full git repository path i.e.:
 		  git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
-		  This will create a git clone of the kernel in your build
-		  directory.
+		  This will create a git clone of the kernel in your build directory.

 	config KERNEL_GIT_LOCAL_REPOSITORY
 		string "Enter path to local reference repository" if DEVEL
@@ -68,7 +68,7 @@ menuconfig DEVEL
 		default ""
 		help
 		  Enter a full pathname to a local reference git repository.
-		  In this instance, the --refererence option of git clone will
+		  In this instance, the --reference option of git clone will
 		  be used thus creating a quick local clone of your repo.

 	config KERNEL_GIT_BRANCH
@@ -83,7 +83,7 @@ menuconfig DEVEL
 	config BUILD_LOG
 		bool "Enable log files during build process" if DEVEL
 		help
-		  If enabled log files will be written to the ./log directory
+		  If enabled, log files will be written to the ./log directory.

 	config SRC_TREE_OVERRIDE
 		bool "Enable package source tree override" if DEVEL
@@ -91,10 +91,10 @@ menuconfig DEVEL
 		  If enabled, you can force a package to use a git tree as source
 		  code instead of the normal tarball. Create a symlink 'git-src'
 		  in the package directory, pointing to the .git tree that you want
-		  to pull the source code from
+		  to pull the source code from.

 	config EXTRA_OPTIMIZATION
 		string "Additional compiler options" if DEVEL
 		default "-fno-caller-saves"
 		help
-		  Extra Target-independent optimizations to use when building for the target.
+		  Extra target-independent optimizations to use when building for the target.
diff --git a/config/Config-images.in b/config/Config-images.in
index 39e51e4..eca2d75 100644
--- a/config/Config-images.in
+++ b/config/Config-images.in
@@ -10,7 +10,7 @@ menu "Target Images"
 		bool "ramdisk"
 		default y if USES_INITRAMFS
 		help
-		  Embed the rootfs into the kernel (initramfs)
+		  Embed the root filesystem into the kernel (initramfs).

 		choice
 			prompt "Compression"
@@ -48,7 +48,7 @@ menu "Target Images"
 			prompt "Use external cpio" if TARGET_ROOTFS_INITRAMFS
 			default ""
 			help
-			  Kernel uses specified external cpio as INITRAMFS_SOURCE
+			  Kernel uses specified external cpio as INITRAMFS_SOURCE.

 	comment "Root filesystem archives"

@@ -56,13 +56,13 @@ menu "Target Images"
 		bool "cpio.gz"
 		default y if USES_CPIOGZ
 		help
-		  Build a compressed cpio archive of the the root filesystem
+		  Build a compressed cpio archive of the root filesystem.

 	config TARGET_ROOTFS_TARGZ
 		bool "tar.gz"
 		default y if USES_TARGZ
 		help
-		  Build a compressed tar archive of the the root filesystem
+		  Build a compressed tar archive of the root filesystem.

 	comment "Root filesystem images"

@@ -70,28 +70,28 @@ menu "Target Images"
 		bool "ext4"
 		default y if USES_EXT4
 		help
-		  Build a ext4 root filesystem
+		  Build an ext4 root filesystem.

 		config TARGET_EXT4_MAXINODE
 			int "Maximum number of inodes in root filesystem"
 			depends on TARGET_ROOTFS_EXT4FS
 			default 6000
 			help
-			  Allows you to change the maximum number of inodes in the root filesystem
+			  Select the maximum number of inodes in the root filesystem.

 		config TARGET_EXT4_RESERVED_PCT
 			int "Percentage of reserved blocks in root filesystem"
 			depends on TARGET_ROOTFS_EXT4FS
 			default 0
 			help
-			  Allows you to change the percentage of reserved blocks in the root filesystem
+			  Select the percentage of reserved blocks in the root filesystem.

 		choice
 			prompt "Root filesystem block size"
 			default TARGET_EXT4_BLOCKSIZE_4K
 			depends on TARGET_ROOTFS_EXT4FS
 			help
-			  Allows you to change the block size of the root filesystem
+			  Select the block size of the root filesystem.

 			config TARGET_EXT4_BLOCKSIZE_4K
 				bool "4k"
@@ -115,33 +115,33 @@ menu "Target Images"
 			depends on TARGET_ROOTFS_EXT4FS
 			default n
 			help
-			  Create an ext4 filesystem with a journal
+			  Create an ext4 filesystem with a journal.

 	config TARGET_ROOTFS_ISO
 		bool "iso"
 		default n
 		depends on TARGET_x86_generic
 		help
-		  Create some bootable ISO image
+		  Create a bootable ISO image.

 	config TARGET_ROOTFS_JFFS2
 		bool "jffs2"
 		default y if USES_JFFS2
 		help
-		  Build a jffs2 root filesystem
+		  Build a JFFS2 root filesystem.

 	config TARGET_ROOTFS_JFFS2_NAND
 		bool "jffs2 for NAND"
 		default y if USES_JFFS2_NAND
 		depends on USES_JFFS2_NAND
 		help
-		  Build a jffs2 root filesystem for NAND flash
+		  Build a JFFS2 root filesystem for NAND flash.

 	menuconfig TARGET_ROOTFS_SQUASHFS
 		bool "squashfs"
 		default y if USES_SQUASHFS
 		help
-		  Build a squashfs-lzma root filesystem
+		  Build a squashfs-lzma root filesystem.

 		config TARGET_SQUASHFS_BLOCK_SIZE
 			int "Block size (in KiB)"
@@ -154,7 +154,7 @@ menu "Target Images"
 		default y if USES_UBIFS
 		depends on USES_UBIFS
 		help
-		  Build a ubifs root filesystem
+		  Build a UBIFS root filesystem.

 		choice
 			prompt "compression"
@@ -177,7 +177,7 @@ menu "Target Images"
 			bool "free space fixup" if TARGET_ROOTFS_UBIFS
 			default y
 			help
-			  The file-system free space has to be fixed up on first mount
+			  The filesystem free space has to be fixed up on first mount.

 		config TARGET_UBIFS_JOURNAL_SIZE
 			string
@@ -262,7 +262,7 @@ menu "Target Images"
 		depends on GRUB_IMAGES || TARGET_ROOTFS_EXT4FS || TARGET_rb532
 		default 48
 		help
-		  Allows you to change the root filesystem partition size
+		  Select the root filesystem partition size.

 	config TARGET_ROOTFS_PARTNAME
 		string "Root partition on target device"
@@ -279,7 +279,7 @@ menu "Target Images"
 		depends on TARGET_ROOTFS_UBIFS || TARGET_ROOTFS_EXT4FS
 		default n
 		help
-		  Include the kernel image in the rootfs. Typically the image is placed
+		  Include the kernel image in the rootfs. Typically, the image is placed
 		  below /boot.

 		config TARGET_ROOTFS_INCLUDE_UIMAGE
diff --git a/config/Config-kernel.in b/config/Config-kernel.in
index 06788d6..0a5c9a2 100644
--- a/config/Config-kernel.in
+++ b/config/Config-kernel.in
@@ -18,12 +18,13 @@ config KERNEL_SWAP
 	default y

 config KERNEL_DEBUG_FS
-	bool "Compile the kernel with Debug FileSystem enabled"
+	bool "Compile the kernel with debug filesystem enabled"
 	default y
 	help
 	  debugfs is a virtual file system that kernel developers use to put
 	  debugging files into. Enable this option to be able to read and
-	  write to these files.
+	  write to these files. Many common debugging facilities, such as
+	  ftrace, require the existence of debugfs.

 config KERNEL_PERF_EVENTS
 	bool
@@ -41,7 +42,7 @@ config KERNEL_KALLSYMS
 	bool "Compile the kernel with symbol table information"
 	default y
 	help
-	  This will give you more information in stack traces from kernel oopses
+	  This will give you more information in stack traces from kernel oopses.

 config KERNEL_FTRACE
 	bool "Compile the kernel with tracing support"
@@ -79,7 +80,7 @@ config KERNEL_DEBUG_LL
 	depends on arm
 	select KERNEL_DEBUG_LL_UART_NONE
 	help
-	  ARM low level debugging
+	  ARM low level debugging.

 config KERNEL_DYNAMIC_DEBUG
 	bool "Compile the kernel with dynamic printk"
@@ -100,9 +101,8 @@ config KERNEL_EARLY_PRINTK
 	select KERNEL_DEBUG_KERNEL
 	select KERNEL_DEBUG_LL if arm
 	help
-	  Compile the kernel with early printk support.
-	  This is only useful for debugging purposes to send messages
-	  over the serial console in early boot.
+	  Compile the kernel with early printk support.  This is only useful for
+	  debugging purposes to send messages over the serial console in early boot.
 	  Enable this to debug early boot problems.

 config KERNEL_AIO
@@ -244,11 +244,11 @@ if KERNEL_CGROUPS
 		  usage tracking struct at boot. Total amount of this is printed out
 		  at boot.

-		  Only enable when you're ok with these trade offs and really
+		  Only enable when you're ok with these tradeoffs and really
 		  sure you need the memory resource controller. Even when you enable
 		  this, you can set "cgroup_disable=memory" at your boot option to
-		  disable memory resource controller and you can avoid overheads.
-		  (and lose benefits of memory resource controller)
+		  disable memory resource controller and you can avoid overheads
+		  (but lose benefits of memory resource controller).

 		  This config option also selects MM_OWNER config option, which
 		  could in turn add some fork/exit overhead.
@@ -282,8 +282,9 @@ if KERNEL_CGROUPS
 		  which want to enable the feature but keep it disabled by default
 		  and let the user enable it by swapaccount boot command line
 		  parameter should have this option unselected.
-		  For those who want to have the feature enabled by default should
-		  select this option (if, for some reason, they need to disable it
+
+		  Those who want to have the feature enabled by default should
+		  select this option (if, for some reason, they need to disable it,
 		  then swapaccount=0 does the trick).


@@ -395,14 +396,14 @@ if KERNEL_NAMESPACES
 		bool "UTS namespace"
 		default y
 		help
-		  In this namespace tasks see different info provided
-		  with the uname() system call
+		  In this namespace, tasks see different info provided
+		  with the uname() system call.

 	config KERNEL_IPC_NS
 		bool "IPC namespace"
 		default y
 		help
-		  In this namespace tasks work with IPC ids which correspond to
+		  In this namespace, tasks work with IPC ids which correspond to
 		  different IPC objects in different namespaces.

 	config KERNEL_USER_NS


-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
openwrt-devel mailing list
openwrt-devel at lists.openwrt.org
https://lists.openwrt.org/cgi-bin/mailman/listinfo/openwrt-devel



More information about the openwrt-devel mailing list