[PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText

[PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText

[Rebecca Cran]

I noticed ReadMe.txt was a little outdated. I updated it to match
current functionality (e.g. BaseTools works on both 32-bit and 64-bit
Windows). Since the formatting was neither RST or MD, I converted it to
RST and renamed to ReadMe.rst to match the edk2 ReadMe.rst.

Some (most?) sqlite use was removed in commit 
2f818ed0fb57d98985d151781a2ce9b8683129ee in 2018, but there are still 
some modules (Ecc/Database.py, Eoc/Database.py and
UPT/Core/IpiDb,py) that do require it, so I'm not sure if the part
about sqlite3 should still be present in the ReadMe file. If so, I think
the text about cx_freeze might be obsolete.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>



Rebecca Cran (2):
  BaseTools: Update ReadMe.txt to match current functionality
  BaseTools: rename ReadMe.txt to ReadMe.rst

 BaseTools/ReadMe.rst | 41 ++++++++++++++++++++++++++++++++++++++
 BaseTools/ReadMe.txt | 47 --------------------------------------------
 2 files changed, 41 insertions(+), 47 deletions(-)
 create mode 100644 BaseTools/ReadMe.rst
 delete mode 100644 BaseTools/ReadMe.txt

-- 
2.25.1

[PATCH 1/2] BaseTools: Update ReadMe.txt to match current functionality

[Rebecca Cran]

ReadMe.txt contained outdated information. Update it to match current
functionality (e.g. sqlite3 is no longer used), and convert the
formatting from ad-hoc to reStructuredText.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
---
 BaseTools/ReadMe.txt | 38 ++++++++++++++++----------------------
 1 file changed, 16 insertions(+), 22 deletions(-)

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index b81bd905fa90..de85ca4be65e 100644
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -1,47 +1,41 @@
-This directory contains the next generation of EDK II build tools and template files.
+This directory contains the EDK II build tools and template files.
 Templates are located in the Conf directory, while the tools executables for
-Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other
+Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
 directory contains tools source.
 
-1. Build step to generate the binary tools.
+Build step to generate the binary tools
+---------------------------------------
 
-=== Windows/Visual Studio Notes ===
+Windows/Visual Studio Notes
+===========================
 
 To build the BaseTools, you should run the standard vsvars32.bat script
 from your preferred Visual Studio installation or you can run get_vsvars.bat
 to use latest automatically detected version.
 
-In addition to this, you should set the following environment variables:
+In addition to this, you should set the following environment variables::
 
  * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
  * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
-   (It is the same directory where this README.txt is located.)
+   (It is the same directory where this README.rst is located.)
 
 After this, you can run the toolsetup.bat file, which is in the same
 directory as this file.  It should setup the remainder of the environment,
 and build the tools if necessary.
 
-Please also refer to the 'BuildNotes.txt' file for more information on
+Please also refer to the ``BuildNotes.txt`` file for more information on
 building under Windows.
 
-=== Unix-like operating systems ===
+Unix-like operating systems
+===========================
 
-To build on Unix-like operating systems, you only need to type 'make' in
+To build on Unix-like operating systems, you only need to type ``make`` in
 the base directory of the project.
 
-=== Ubuntu Notes ===
+Ubuntu Notes
+============
 
 On Ubuntu, the following command should install all the necessary build
-packages to build all the C BaseTools:
+packages to build all the C BaseTools::
 
-  sudo apt-get install build-essential uuid-dev
-
-=== Python sqlite3 module ===
-On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen
-binary directory (the same directory as build.exe and GenFds.exe).
-Please copy it manually from <PythonHome>\DLLs.
-
-The Python distributed with most recent Linux will have sqlite3 module
-built in. If not, please install sqlit3 package separately.
-
-26-OCT-2011
+ sudo apt install build-essential uuid-dev
-- 
2.25.1

[PATCH 2/2] BaseTools: rename ReadMe.txt to ReadMe.rst

[Rebecca Cran]

The ReadMe file is now RST, so update the filename extension to match.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
---
 BaseTools/{ReadMe.txt => ReadMe.rst} | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename BaseTools/{ReadMe.txt => ReadMe.rst} (100%)

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.rst
similarity index 100%
rename from BaseTools/ReadMe.txt
rename to BaseTools/ReadMe.rst
-- 
2.25.1

Re: [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText

[Rebecca Cran]

On 7/7/20 5:13 PM, Rebecca Cran wrote:

> I noticed ReadMe.txt was a little outdated. I updated it to match
> current functionality (e.g. BaseTools works on both 32-bit and 64-bit
> Windows). Since the formatting was neither RST or MD, I converted it to
> RST and renamed to ReadMe.rst to match the edk2 ReadMe.rst.

Is this change not wanted at the moment? I've not seen any comments on 
the patch yet.


-- 
Rebecca Cran

Re: [edk2-devel] [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText

[Bob Feng]

Rebecca,

Thanks for updating this file.

Reviewed-by: Bob Feng <bob.c.feng@intel.com>

Thanks,
Bob

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Rebecca Cran
Sent: Wednesday, July 8, 2020 7:13 AM
To: devel@edk2.groups.io
Cc: Rebecca Cran <rebecca@bsdio.com>; Feng, Bob C <bob.c.feng@intel.com>; Gao, Liming <liming.gao@intel.com>
Subject: [edk2-devel] [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText

I noticed ReadMe.txt was a little outdated. I updated it to match current functionality (e.g. BaseTools works on both 32-bit and 64-bit Windows). Since the formatting was neither RST or MD, I converted it to RST and renamed to ReadMe.rst to match the edk2 ReadMe.rst.

Some (most?) sqlite use was removed in commit 2f818ed0fb57d98985d151781a2ce9b8683129ee in 2018, but there are still some modules (Ecc/Database.py, Eoc/Database.py and
UPT/Core/IpiDb,py) that do require it, so I'm not sure if the part about sqlite3 should still be present in the ReadMe file. If so, I think the text about cx_freeze might be obsolete.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>



Rebecca Cran (2):
  BaseTools: Update ReadMe.txt to match current functionality
  BaseTools: rename ReadMe.txt to ReadMe.rst

 BaseTools/ReadMe.rst | 41 ++++++++++++++++++++++++++++++++++++++
 BaseTools/ReadMe.txt | 47 --------------------------------------------
 2 files changed, 41 insertions(+), 47 deletions(-)  create mode 100644 BaseTools/ReadMe.rst  delete mode 100644 BaseTools/ReadMe.txt

--
2.25.1