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

Rebecca Cran posted 2 patches 3 years, 9 months ago
Only 1 patches received!
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
[edk2-devel] [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText
Posted by Rebecca Cran 3 years, 9 months ago
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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62178): https://edk2.groups.io/g/devel/message/62178
Mute This Topic: https://groups.io/mt/75366649/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText
Posted by Bob Feng 3 years, 9 months ago
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






-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62942): https://edk2.groups.io/g/devel/message/62942
Mute This Topic: https://groups.io/mt/75366649/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] BaseTools: Convert ReadMe.txt to reStructuredText
Posted by Rebecca Cran 3 years, 9 months ago
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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62702): https://edk2.groups.io/g/devel/message/62702
Mute This Topic: https://groups.io/mt/75366649/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 2/2] BaseTools: rename ReadMe.txt to ReadMe.rst
Posted by Rebecca Cran 3 years, 9 months ago
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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#62180): https://edk2.groups.io/g/devel/message/62180
Mute This Topic: https://groups.io/mt/75366653/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-