diff mbox

[1/3] Revert e4dfc5e8e("Move README to markdown")

Message ID 20160720193955.21782-2-bobby.prani@gmail.com
State New
Headers show

Commit Message

Pranith Kumar July 20, 2016, 7:39 p.m. UTC
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%)

Comments

Stefan Weil July 20, 2016, 8:14 p.m. UTC | #1
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
diff mbox

Patch

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