[Qemu-devel] [PATCH 0/3] Fix regression caused my moving README

[Qemu-devel] [PATCH 0/3] Fix regression caused my moving README

[Pranith Kumar]

When we renamed README we caused a bunch of regressions caused by
checkpatch.pl and the windows installer which check for the presence
of the README file. The ensuring discussion made it clear that having
a symlink is preferable. This patch series implements that.

This works as expected and can be seen here: https://github.com/pranith/qemu/tree/markdown

Pranith Kumar (3):
  Revert e4dfc5e8e("Move README to markdown")
  Create README.md as a symlink to README
  Update README to accomodate markdown format

 README    | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 107 +-------------------------------------------------------------
 2 files changed, 106 insertions(+), 106 deletions(-)
 create mode 100644 README
 mode change 100644 => 120000 README.md

-- 
2.9.2

[Qemu-devel] [PATCH 1/3] Revert e4dfc5e8e("Move README to markdown")

[Pranith Kumar]

checkpatch.pl and other scripts fail without README. Also in dicussions
it was deemed safer to create a symlink, the patch for which follows.

This reverts commit e5dfc5e8e715c572aea44ac4d96c43941d4741c7.

Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
---
 README.md => README | 41 +++++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 20 deletions(-)
 rename README.md => README (85%)

diff --git a/README.md b/README
similarity index 85%
rename from README.md
rename to README
index 99da481..f38193f 100644
--- a/README.md
+++ b/README
@@ -1,5 +1,5 @@
-QEMU
----
+         QEMU README
+         ===========
 
 QEMU is a generic and open source machine & userspace emulator and
 virtualizer.
@@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file.
 
 
 Building
----
+========
 
 QEMU is multi-platform software intended to be buildable on all modern
 Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
 of other UNIX targets. The simple steps to build QEMU are:
 
-	mkdir build
-	cd build
-	../configure
-	make
+  mkdir build
+  cd build
+  ../configure
+  make
 
 Complete details of the process for building and configuring QEMU for
 all supported host platforms can be found in the qemu-tech.html file.
 Additional information can also be found online via the QEMU website:
 
-	http://qemu-project.org/Hosts/Linux
-	http://qemu-project.org/Hosts/W32
+  http://qemu-project.org/Hosts/Linux
+  http://qemu-project.org/Hosts/W32
 
 
 Submitting patches
----
+==================
 
 The QEMU source code is maintained under the GIT version control system.
 
-	git clone git://git.qemu-project.org/qemu.git
+   git clone git://git.qemu-project.org/qemu.git
 
 When submitting patches, the preferred approach is to use 'git
 format-patch' and/or 'git send-email' to format & send the mail to the
@@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files.
 Additional information on submitting patches can be found online via
 the QEMU website
 
-	http://qemu-project.org/Contribute/SubmitAPatch
-	http://qemu-project.org/Contribute/TrivialPatches
+  http://qemu-project.org/Contribute/SubmitAPatch
+  http://qemu-project.org/Contribute/TrivialPatches
 
 
 Bug reporting
----
+=============
 
 The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
 found when running code built from QEMU git or upstream released sources
 should be reported via:
 
-	https://bugs.launchpad.net/qemu/
+  https://bugs.launchpad.net/qemu/
 
 If using QEMU via an operating system vendor pre-built binary package, it
 is preferable to report bugs to the vendor's own bug tracker first. If
@@ -86,21 +86,22 @@ reported via launchpad.
 
 For additional information on bug reporting consult:
 
-	http://qemu-project.org/Contribute/ReportABug
+  http://qemu-project.org/Contribute/ReportABug
 
 
 Contact
----
+=======
 
 The QEMU community can be contacted in a number of ways, with the two
 main methods being email and IRC
 
- - Mailing List: qemu-devel@nongnu.org
- - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel
- - IRC: #qemu on irc.oftc.net
+ - qemu-devel@nongnu.org
+   http://lists.nongnu.org/mailman/listinfo/qemu-devel
+ - #qemu on irc.oftc.net
 
 Information on additional methods of contacting the community can be
 found online via the QEMU website:
 
   http://qemu-project.org/Contribute/StartHere
 
+-- End
-- 
2.9.2

Re: [Qemu-devel] [PATCH 1/3] Revert e4dfc5e8e("Move README to markdown")

[Stefan Weil]

On 07/20/16 21:39, Pranith Kumar wrote:
> checkpatch.pl and other scripts fail without README. Also in dicussions
> it was deemed safer to create a symlink, the patch for which follows.
> 
> This reverts commit e5dfc5e8e715c572aea44ac4d96c43941d4741c7.
> 
> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
> ---
>  README.md => README | 41 +++++++++++++++++++++--------------------
>  1 file changed, 21 insertions(+), 20 deletions(-)
>  rename README.md => README (85%)
> 
> diff --git a/README.md b/README
> similarity index 85%
> rename from README.md
> rename to README
> index 99da481..f38193f 100644
> --- a/README.md
> +++ b/README
> @@ -1,5 +1,5 @@
> -QEMU
> ----
> +         QEMU README
> +         ===========
>  
>  QEMU is a generic and open source machine & userspace emulator and
>  virtualizer.
> @@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file.
>  
>  
>  Building
> ----
> +========
>  
>  QEMU is multi-platform software intended to be buildable on all modern
>  Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
>  of other UNIX targets. The simple steps to build QEMU are:
>  
> -	mkdir build
> -	cd build
> -	../configure
> -	make
> +  mkdir build
> +  cd build
> +  ../configure
> +  make
>  
>  Complete details of the process for building and configuring QEMU for
>  all supported host platforms can be found in the qemu-tech.html file.
>  Additional information can also be found online via the QEMU website:
>  
> -	http://qemu-project.org/Hosts/Linux
> -	http://qemu-project.org/Hosts/W32
> +  http://qemu-project.org/Hosts/Linux
> +  http://qemu-project.org/Hosts/W32
>  
>  
>  Submitting patches
> ----
> +==================
>  
>  The QEMU source code is maintained under the GIT version control system.
>  
> -	git clone git://git.qemu-project.org/qemu.git
> +   git clone git://git.qemu-project.org/qemu.git
>  
>  When submitting patches, the preferred approach is to use 'git
>  format-patch' and/or 'git send-email' to format & send the mail to the
> @@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files.
>  Additional information on submitting patches can be found online via
>  the QEMU website
>  
> -	http://qemu-project.org/Contribute/SubmitAPatch
> -	http://qemu-project.org/Contribute/TrivialPatches
> +  http://qemu-project.org/Contribute/SubmitAPatch
> +  http://qemu-project.org/Contribute/TrivialPatches
>  
>  
>  Bug reporting
> ----
> +=============
>  
>  The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
>  found when running code built from QEMU git or upstream released sources
>  should be reported via:
>  
> -	https://bugs.launchpad.net/qemu/
> +  https://bugs.launchpad.net/qemu/
>  
>  If using QEMU via an operating system vendor pre-built binary package, it
>  is preferable to report bugs to the vendor's own bug tracker first. If
> @@ -86,21 +86,22 @@ reported via launchpad.
>  
>  For additional information on bug reporting consult:
>  
> -	http://qemu-project.org/Contribute/ReportABug
> +  http://qemu-project.org/Contribute/ReportABug
>  
>  
>  Contact
> ----
> +=======
>  
>  The QEMU community can be contacted in a number of ways, with the two
>  main methods being email and IRC
>  
> - - Mailing List: qemu-devel@nongnu.org
> - - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel
> - - IRC: #qemu on irc.oftc.net
> + - qemu-devel@nongnu.org
> +   http://lists.nongnu.org/mailman/listinfo/qemu-devel
> + - #qemu on irc.oftc.net
>  
>  Information on additional methods of contacting the community can be
>  found online via the QEMU website:
>  
>    http://qemu-project.org/Contribute/StartHere
>  
> +-- End
> 


Reviewed-by: Stefan Weil <sw@weilnetz.de>

Peter, I suggest to apply this first patch before tagging the next
release version. This will fix the current regression.

Kind regards,
Stefan

[Qemu-devel] [PATCH 2/3] Create README.md as a symlink to README

[Pranith Kumar]

Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
---
 README.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 120000 README.md

diff --git a/README.md b/README.md
new file mode 120000
index 0000000..100b938
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+README
\ No newline at end of file
-- 
2.9.2

[Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Pranith Kumar]

Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
---
 README | 44 +++++++++++++++++++++-----------------------
 1 file changed, 21 insertions(+), 23 deletions(-)

diff --git a/README b/README
index f38193f..8d5744d 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-         QEMU README
-         ===========
+QEMU
+===
 
 QEMU is a generic and open source machine & userspace emulator and
 virtualizer.
@@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file.
 
 
 Building
-========
+===
 
 QEMU is multi-platform software intended to be buildable on all modern
 Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
 of other UNIX targets. The simple steps to build QEMU are:
 
-  mkdir build
-  cd build
-  ../configure
-  make
+   mkdir build
+   cd build
+   ../configure
+   make
 
 Complete details of the process for building and configuring QEMU for
 all supported host platforms can be found in the qemu-tech.html file.
 Additional information can also be found online via the QEMU website:
 
-  http://qemu-project.org/Hosts/Linux
-  http://qemu-project.org/Hosts/W32
+  - http://qemu-project.org/Hosts/Linux
+  - http://qemu-project.org/Hosts/W32
 
 
 Submitting patches
-==================
+===
 
 The QEMU source code is maintained under the GIT version control system.
 
-   git clone git://git.qemu-project.org/qemu.git
+    git clone git://git.qemu-project.org/qemu.git
 
 When submitting patches, the preferred approach is to use 'git
 format-patch' and/or 'git send-email' to format & send the mail to the
@@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files.
 Additional information on submitting patches can be found online via
 the QEMU website
 
-  http://qemu-project.org/Contribute/SubmitAPatch
-  http://qemu-project.org/Contribute/TrivialPatches
+  - http://qemu-project.org/Contribute/SubmitAPatch
+  - http://qemu-project.org/Contribute/TrivialPatches
 
 
 Bug reporting
-=============
+===
 
 The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
 found when running code built from QEMU git or upstream released sources
 should be reported via:
 
-  https://bugs.launchpad.net/qemu/
+  - https://bugs.launchpad.net/qemu/
 
 If using QEMU via an operating system vendor pre-built binary package, it
 is preferable to report bugs to the vendor's own bug tracker first. If
@@ -86,22 +86,20 @@ reported via launchpad.
 
 For additional information on bug reporting consult:
 
-  http://qemu-project.org/Contribute/ReportABug
+  - http://qemu-project.org/Contribute/ReportABug
 
 
 Contact
-=======
+===
 
 The QEMU community can be contacted in a number of ways, with the two
 main methods being email and IRC
 
- - qemu-devel@nongnu.org
-   http://lists.nongnu.org/mailman/listinfo/qemu-devel
- - #qemu on irc.oftc.net
+ - Mailing List: qemu-devel@nongnu.org
+ - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel
+ - IRC: #qemu on irc.oftc.net
 
 Information on additional methods of contacting the community can be
 found online via the QEMU website:
 
-  http://qemu-project.org/Contribute/StartHere
-
--- End
+  - http://qemu-project.org/Contribute/StartHere
\ No newline at end of file
-- 
2.9.2

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Stefan Weil]

[-- Attachment #1: Type: text/plain, Size: 4237 bytes --]

See comments below.

On 07/20/16 21:39, Pranith Kumar wrote:
> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
> ---
>  README | 44 +++++++++++++++++++++-----------------------
>  1 file changed, 21 insertions(+), 23 deletions(-)
> 
> diff --git a/README b/README
> index f38193f..8d5744d 100644
> --- a/README
> +++ b/README
> @@ -1,5 +1,5 @@
> -         QEMU README
> -         ===========
> +QEMU
> +===

Underlining may be longer than 3 characters. Use 4 here (looks better
for raw README).

>  
>  QEMU is a generic and open source machine & userspace emulator and
>  virtualizer.
> @@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file.
>  
>  
>  Building
> -========
> +===

No need to change here.
If you want to change it, use ------- as underline.

>  
>  QEMU is multi-platform software intended to be buildable on all modern
>  Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
>  of other UNIX targets. The simple steps to build QEMU are:
>  
> -  mkdir build
> -  cd build
> -  ../configure
> -  make
> +   mkdir build
> +   cd build
> +   ../configure
> +   make

Indentation here is only 3, must be 4 for code blocks.

>  
>  Complete details of the process for building and configuring QEMU for
>  all supported host platforms can be found in the qemu-tech.html file.
>  Additional information can also be found online via the QEMU website:
>  
> -  http://qemu-project.org/Hosts/Linux
> -  http://qemu-project.org/Hosts/W32
> +  - http://qemu-project.org/Hosts/Linux
> +  - http://qemu-project.org/Hosts/W32

No indentation needed here.

>  
>  
>  Submitting patches
> -==================
> +===

No need to change here. Same as above.

>  
>  The QEMU source code is maintained under the GIT version control system.
>  
> -   git clone git://git.qemu-project.org/qemu.git
> +    git clone git://git.qemu-project.org/qemu.git
>  
>  When submitting patches, the preferred approach is to use 'git
>  format-patch' and/or 'git send-email' to format & send the mail to the
> @@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files.
>  Additional information on submitting patches can be found online via
>  the QEMU website
>  
> -  http://qemu-project.org/Contribute/SubmitAPatch
> -  http://qemu-project.org/Contribute/TrivialPatches
> +  - http://qemu-project.org/Contribute/SubmitAPatch
> +  - http://qemu-project.org/Contribute/TrivialPatches

No indentation needed here.

>  
>  
>  Bug reporting
> -=============
> +===

No need to change here. Same as above.

>  
>  The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
>  found when running code built from QEMU git or upstream released sources
>  should be reported via:
>  
> -  https://bugs.launchpad.net/qemu/
> +  - https://bugs.launchpad.net/qemu/

No indentation needed.

>  
>  If using QEMU via an operating system vendor pre-built binary package, it
>  is preferable to report bugs to the vendor's own bug tracker first. If
> @@ -86,22 +86,20 @@ reported via launchpad.
>  
>  For additional information on bug reporting consult:
>  
> -  http://qemu-project.org/Contribute/ReportABug
> +  - http://qemu-project.org/Contribute/ReportABug

No indentation needed.

>  
>  
>  Contact
> -=======
> +===

No need to change here. Same as above.

>  
>  The QEMU community can be contacted in a number of ways, with the two
>  main methods being email and IRC
>  
> - - qemu-devel@nongnu.org
> -   http://lists.nongnu.org/mailman/listinfo/qemu-devel
> - - #qemu on irc.oftc.net
> + - Mailing List: qemu-devel@nongnu.org
> + - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel
> + - IRC: #qemu on irc.oftc.net
>  
>  Information on additional methods of contacting the community can be
>  found online via the QEMU website:
>  
> -  http://qemu-project.org/Contribute/StartHere
> -
> --- End
> +  - http://qemu-project.org/Contribute/StartHere
> \ No newline at end of file
> 

I'd also switch commits 2 and 3, because 2 is only valid as soon as
README is in markup format.

Regards,
Stefan



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Pranith Kumar]

Thank you for reviewing.

On Wed, Jul 20, 2016 at 4:10 PM, Stefan Weil <sw@weilnetz.de> wrote:
> See comments below.

<snip>
>
> I'd also switch commits 2 and 3, because 2 is only valid as soon as
> README is in markup format.
>

OK, I will update patches 2 and 3 and resend a v2.

Thanks!
-- 
Pranith

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 674 bytes --]

On 07/20/2016 01:39 PM, Pranith Kumar wrote:
> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
> ---
>  README | 44 +++++++++++++++++++++-----------------------
>  1 file changed, 21 insertions(+), 23 deletions(-)
> 

In addition to Stefan's comments,


>  Information on additional methods of contacting the community can be
>  found online via the QEMU website:
>  
> -  http://qemu-project.org/Contribute/StartHere
> -
> --- End
> +  - http://qemu-project.org/Contribute/StartHere
> \ No newline at end of file

Why no ending newline?

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Pranith Kumar]

On Wed, Jul 20, 2016 at 5:29 PM, Eric Blake <eblake@redhat.com> wrote:
> On 07/20/2016 01:39 PM, Pranith Kumar wrote:
>> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
>> ---
>>  README | 44 +++++++++++++++++++++-----------------------
>>  1 file changed, 21 insertions(+), 23 deletions(-)
>>
>
> In addition to Stefan's comments,
>
>
>>  Information on additional methods of contacting the community can be
>>  found online via the QEMU website:
>>
>> -  http://qemu-project.org/Contribute/StartHere
>> -
>> --- End
>> +  - http://qemu-project.org/Contribute/StartHere
>> \ No newline at end of file
>
> Why no ending newline?
>

Hmm, the original README did not have an explicit new line at end of
file. I am not sure if it is really necessary though. Why do we need
one?

-- 
Pranith

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 718 bytes --]

On 07/20/2016 03:33 PM, Pranith Kumar wrote:

>>> +  - http://qemu-project.org/Contribute/StartHere
>>> \ No newline at end of file
>>
>> Why no ending newline?
>>
> 
> Hmm, the original README did not have an explicit new line at end of
> file. I am not sure if it is really necessary though. Why do we need
> one?

Technically, ALL text files should have an ending newline.  POSIX says
that a file without an ending newline is not a text file, at which point
programs like sed and grep are allowed to do rather interesting things
(such as refuse to process the file because it is binary).

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Peter Maydell]

On 20 July 2016 at 22:33, Pranith Kumar <bobby.prani@gmail.com> wrote:
> Hmm, the original README did not have an explicit new line at end of
> file.

Yes it did:
$ git show 70f87e0f0a:README | tail -c 1 | od -An -a
  nl

thanks
-- PMM

Re: [Qemu-devel] [PATCH 3/3] Update README to accomodate markdown format

[Pranith Kumar]

On Wed, Jul 20, 2016 at 6:07 PM, Peter Maydell <peter.maydell@linaro.org> wrote:
> On 20 July 2016 at 22:33, Pranith Kumar <bobby.prani@gmail.com> wrote:
>> Hmm, the original README did not have an explicit new line at end of
>> file.
>
> Yes it did:
> $ git show 70f87e0f0a:README | tail -c 1 | od -An -a
>   nl
>

OK.

The v2 version of the patch I sent earlier has this fixed. I thought
that Eric was commenting on that version but he was commenting on v1.

Thanks,
-- 
Pranith