Skip to contentSkip to conversation

doc: Remove trailing spaces

PATCH In review Axel Heider 2 participants 4 messages Aug 3, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 2/2 doc: Remove trailing spaces

---
 qemu-options.hx | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)
qemu-options.hx +15 -15
index e3f256fa72..ed91246114 100644
@@ -244,15 +244,15 @@ DEF("numa", HAS_ARG, QEMU_OPTION_numa,
     QEMU_ARCH_ALL)
 SRST
 ``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``
-  \
+  \
 ``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``
   \
 ``-numa dist,src=source,dst=destination,val=distance``
-  \
+  \
 ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]``
-  \
+  \
 ``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]``
-  \
+  \
 ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]``
     Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA
     distance from a source node to a destination node. Set the ACPI
@@ -447,7 +447,7 @@ DEF("global", HAS_ARG, QEMU_OPTION_global,
     QEMU_ARCH_ALL)
 SRST
 ``-global driver.prop=value``
-  \
+  \
 ``-global driver=driver,property=property,value=value``
     Set default value of driver's property prop to value, e.g.:
 
@@ -1026,9 +1026,9 @@ SRST
 ``-hda file``
   \
 ``-hdb file``
-  \
+  \
 ``-hdc file``
-  \
+  \
 ``-hdd file``
     Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images`
     chapter in the System Emulation Users Guide).
@@ -1518,7 +1518,7 @@ DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
 
 SRST
 ``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly=on][,fmode=fmode][,dmode=dmode] [,throttling.option=value[,throttling.option=value[,...]]]``
-  \
+  \
 ``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]``
   \
 ``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]``
@@ -1639,9 +1639,9 @@ DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
 
 SRST
 ``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]``
-  \
+  \
 ``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]``
-  \
+  \
 ``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]``
   \
 ``-virtfs synth,mount_tag=mount_tag``
@@ -3873,10 +3873,10 @@ DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
     "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
 SRST
 ``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
-    Setup monitor on chardev name. ``mode=control`` configures
+    Setup monitor on chardev name. ``mode=control`` configures
     a QMP monitor (a JSON RPC-style protocol) and it is not the
     same as HMP, the human monitor that has a "(qemu)" prompt.
-    ``pretty`` is only valid when ``mode=control``,
+    ``pretty`` is only valid when ``mode=control``,
     turning on JSON pretty printing to ease
     human reading and debugging.
 ERST
@@ -3937,7 +3937,7 @@ DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
     QEMU_ARCH_ALL)
 SRST
 ``-overcommit mem-lock=on|off``
-  \
+  \
 ``-overcommit cpu-pm=on|off``
     Run qemu with hints about host resource overcommit. The default is
     to assume that host overcommits all resources.
@@ -4323,7 +4323,7 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
     QEMU_ARCH_ALL)
 SRST
 ``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]``
-  \
+  \
 ``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]``
     Prepare for incoming migration, listen on a given tcp port.
 
@@ -5072,7 +5072,7 @@ SRST
                [...]
 
     ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]``
-      \
+      \
     ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]``
         Defines a secret to store a password, encryption key, or some
         other sensitive data. The sensitive data can either be passed

--
2.17.1

#1 lore raw
Quoted 11 lines · Axel Heider
---
  qemu-options.hx | 30 +++++++++++++++---------------
  1 file changed, 15 insertions(+), 15 deletions(-)
qemu-options.hx +0 -0
index e3f256fa72..ed91246114 100644

qemu-options.hx DEF("numa", HAS_ARG, QEMU_OPTION_numa, · line 247

Quoted 5 lines
qemu-options.hx +1 -1
@@ -244,15 +244,15 @@ DEF("numa", HAS_ARG, QEMU_OPTION_numa,
      QEMU_ARCH_ALL)
  SRST
  ``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``
-  \
+  \

Something seems to have gone wrong in sending your patch here -- the commit message claims it's deleting trailing spaces but the patch itself doesn't do that. Something in the email path deleted trailing spaces in the patch (I suspect the issue is the 'format=flowed' in your email).

Also, did you check that the docs still build without warnings from a range of Sphinx versions and that the rendered HTML still looks the same ? These trailing spaces were largely added deliberately in commit 09ce5f2d6bd6739144, with the comment
* rST does not like definition list entries with no actual definition, but it is possible to work around this by putting a single escaped literal space as the definition line.

so we should be careful not to delete them again unless we've confirmed that we definitely don't re-introduce the issue that we put them in to avoid...

thanks
-- PMM

#2 lore raw

Peter,

Quoted 11 lines

Also, did you check that the docs still build without warnings from a range of Sphinx versions and that the rendered HTML still looks the same ? These trailing spaces were largely added deliberately in commit 09ce5f2d6bd6739144, with the comment
* rST does not like definition list entries with no actual definition, but it is possible to work around this by putting a single escaped literal space as the definition line.

so we should be careful not to delete them again unless we've confirmed that we definitely don't re-introduce the issue that we put them in to avoid...

Then please drop the patch 2/2 for now and just keep 1/2. I will run more tests about this and see if I can find a way to avoid the need for having traling spaces in the file. They are a bit dangerous as most editors are set up to remove them, whch creates annoying changes all the time then.

Axel

#3 lore raw
Quoted 5 lines · Axel Heider

Then please drop the patch 2/2 for now and just keep 1/2. I will run more tests about this and see if I can find a way to avoid the need for having traling spaces in the file. They are a bit dangerous as most editors are set up to remove them, whch creates annoying changes all the time then.

You should configure your editor not to delete trailing spaces or otherwise make whole-file changes like that. Otherwise you'll constantly be making changes you didn't intend...

I agree that if we can avoid the trailing spaces that would be the best thing -- they're a pretty ugly and fragile workaround for a rST awkwardness.

-- PMM