Skip to contentSkip to conversation

fs: Kconfig: Alignment of code and text in the FS_DAX help section for better readability

PATCH In review Bhaskar Chowdhury 2 participants 3 messages Aug 23 – Sep 2 1 message not in the archive VFS

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 fs: Kconfig: Alignment of code and text in the FS_DAX help section for better readability

I thought eliminating the line break and add an empty line would improve the readability.

---
Changes from V1:
Getting rid of the unwanted ":" ;that was the source of build failure.

 fs/Kconfig | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
fs/Kconfig +3 -4
index e05917adcd60..a2e724cae76f 100644
@@ -71,11 +71,10 @@ config FS_DAX
 	  struct pages.  For the nfit based NVDIMMs this can be enabled
 	  using the ndctl utility:
 
-		# ndctl create-namespace --force --reconfig=namespace0.0 \
-			--mode=fsdax --map=mem
+	  # ndctl create-namespace --force --reconfig=namespace0.0 --mode=fsdax --map=mem
+
+	  See the 'create-namespace' man page for details on the overhead of --map=mem
 
-	  See the 'create-namespace' man page for details on the overhead of
-	  --map=mem:
 	  https://docs.pmem.io/ndctl-user-guide/ndctl-man-pages/ndctl-create-namespace
 
 	  For ndctl to work CONFIG_DEV_DAX needs to be enabled as well. For most

--
2.54.0

reviewer
#1 lore raw
Quoted 7 lines · Bhaskar Chowdhury

I thought eliminating the line break and add an empty line would improve the readability.

I don't know. It depends on the width of your terminal what's more readable. I'd just leave it as is.

Honza

Quoted 28 lines

---
Changes from V1:
Getting rid of the unwanted ":" ;that was the source of build failure.

 fs/Kconfig | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
fs/Kconfig +3 -5
index e05917adcd60..a2e724cae76f 100644
@@ -71,11 +71,10 @@ config FS_DAX
 	  struct pages.  For the nfit based NVDIMMs this can be enabled
 	  using the ndctl utility:
 
-		# ndctl create-namespace --force --reconfig=namespace0.0 \
-			--mode=fsdax --map=mem
+	  # ndctl create-namespace --force --reconfig=namespace0.0 --mode=fsdax --map=mem
+
+	  See the 'create-namespace' man page for details on the overhead of --map=mem
 
-	  See the 'create-namespace' man page for details on the overhead of
-	  --map=mem:
 	  https://docs.pmem.io/ndctl-user-guide/ndctl-man-pages/ndctl-create-namespace
 
 	  For ndctl to work CONFIG_DEV_DAX needs to be enabled as well. For most
--

2.54.0

Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR

A message that is not in the archive (sent off-list or not yet received): [email protected]

reviewer
#3 lore raw
Quoted 6 lines · Bhaskar Chowdhury

Ah, you are missing the point. Reading a single straight line and read a divided line make difference.

I took away the line divisor( the forward slash at the end of line to break it) and while doing so, the colon at the end of it produces "build error" as the kernel-test-robots complained.

No, I got that part. What I was objecting to was that merging these split lines into longer ones is beneficial. I've actually tried in my terminal and after the proposed patch things actually look worse (the long lines get trimmed in the view, you have to use right arrow to scroll the kconfig help window to see them all).

Honza

Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR