[PATCH v2 0/2] Top-level makefile and cleanups


Al Stone
 

On 19 Nov 2020 10:54, Anup Patel wrote:
This series adds top-level makefile and does cleanups to generate PDF and
HTML documents which are easy to read/navigate.

Changes since v1:
- Use RISC-V privilege style naming convention in PATCH2 for RISC-V
CSR, CSR fields, and registers.

Anup Patel (2):
Add a makefile to build usable documents
Clean-up entire document for consistency and better structure

Makefile | 29 +++
README.adoc | 13 +
riscv-sbi.adoc | 640 +++++++++++++++++++++++++++++--------------------
3 files changed, 426 insertions(+), 256 deletions(-)
create mode 100644 Makefile

--
2.25.1
In general, these look like pretty good cleanups.

I agree with Atish in his reviews where some consistency in the spec
format would be nice. I'm not going to be pedantic about it, though,
as long as we get the content correct.

I'll wait until you get the next version out and then provide much
more detailed review.

Thanks for doing this, too. The PDF (or HTML) is much easier to
read than the asciidoc :).

--
ciao,
al
-----------------------------------
Al Stone
Software Engineer
Red Hat, Inc.
ahs3@...
-----------------------------------


Anup Patel
 

-----Original Message-----
From: Atish Patra <Atish.Patra@...>
Sent: 19 November 2020 23:49
To: tech-unixplatformspec@...; Anup Patel
<Anup.Patel@...>
Cc: ahs3@...
Subject: Re: [PATCH v2 0/2] Top-level makefile and cleanups

On Thu, 2020-11-19 at 10:54 +0530, Anup Patel wrote:
This series adds top-level makefile and does cleanups to generate PDF
and HTML documents which are easy to read/navigate.

Changes since v1:
- Use RISC-V privilege style naming convention in PATCH2 for RISC-V
CSR, CSR fields, and registers.

Anup Patel (2):
Add a makefile to build usable documents
Clean-up entire document for consistency and better structure

Makefile | 29 +++
README.adoc | 13 +
riscv-sbi.adoc | 640 +++++++++++++++++++++++++++++----------------
----
3 files changed, 426 insertions(+), 256 deletions(-) create mode
100644 Makefile
I think SBI specification should follow the same formatting as the platform
spec. Here are few differences in generated pdf.

1. First page should contain the title and a version in next line with small font
2. 2nd page should contain Table of contents.
3. Change log (if everybody prefers that) 4. Copyright & License information
in next page and shouldn't be part of the Table of Contents.
Okay, will reorder.


--
Regards,
Atish
Regards,
Anup


atishp@...
 

On Thu, 2020-11-19 at 10:54 +0530, Anup Patel wrote:
This series adds top-level makefile and does cleanups to generate PDF
and
HTML documents which are easy to read/navigate.

Changes since v1:
- Use RISC-V privilege style naming convention in PATCH2 for RISC-V
CSR, CSR fields, and registers.

Anup Patel (2):
Add a makefile to build usable documents
Clean-up entire document for consistency and better structure

Makefile | 29 +++
README.adoc | 13 +
riscv-sbi.adoc | 640 +++++++++++++++++++++++++++++----------------
----
3 files changed, 426 insertions(+), 256 deletions(-)
create mode 100644 Makefile
I think SBI specification should follow the same formatting as the
platform spec. Here are few differences in generated pdf.

1. First page should contain the title and a version in next line with
small font
2. 2nd page should contain Table of contents.
3. Change log (if everybody prefers that)
4. Copyright & License information in next page and shouldn't be part
of the Table of Contents.

--
Regards,
Atish


Anup Patel
 

This series adds top-level makefile and does cleanups to generate PDF and
HTML documents which are easy to read/navigate.

Changes since v1:
- Use RISC-V privilege style naming convention in PATCH2 for RISC-V
CSR, CSR fields, and registers.

Anup Patel (2):
Add a makefile to build usable documents
Clean-up entire document for consistency and better structure

Makefile | 29 +++
README.adoc | 13 +
riscv-sbi.adoc | 640 +++++++++++++++++++++++++++++--------------------
3 files changed, 426 insertions(+), 256 deletions(-)
create mode 100644 Makefile

--
2.25.1