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

[Stefan Weil]

See comments below.

On 07/20/16 21:39, Pranith Kumar wrote:
> Signed-off-by: Pranith Kumar <address@hidden>
> ---
>  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
>  
> - - address@hidden
> -   http://lists.nongnu.org/mailman/listinfo/qemu-devel
> - - #qemu on irc.oftc.net
> + - Mailing List: address@hidden
> + - 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

signature.asc
Description: OpenPGP digital signature