Skip to content

Commit

Permalink
Cleanup title page
Browse files Browse the repository at this point in the history
Only print the specification state on the title page, not the entire
text. In order to remove the text, add support to override revremark
with a Makefile variable, and also support VERSION and DATE overrides.
For example, v1.0.1 may now be built with

  make VERSION=v1.0.1 REVMARK=Ratified

Signed-off-by: Andrew Jones <[email protected]>
  • Loading branch information
jones-drew committed Oct 9, 2024
1 parent c82a370 commit 4d14faf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ ifeq ($(strip $(GITVERSION)),)
GITVERSION := no_tag
endif

VERSION ?= ${GITVERSION}
DATE ?= ${COMMITDATE}
REVMARK ?= Draft

DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \
riscvintl/riscv-docs-base-container-image:latest

Expand All @@ -29,8 +33,9 @@ ASCIIDOCTOR_PDF := asciidoctor-pdf
OPTIONS := --trace \
-a compress \
-a mathematical-format=svg \
-a revnumber=${GITVERSION} \
-a revdate=${COMMITDATE} \
-a revnumber=${VERSION} \
-a revdate=${DATE} \
-a revremark=${REVMARK} \
-a pdf-fontsdir=docs-resources/fonts \
-a pdf-style=docs-resources/themes/riscv-pdf.yml \
--failure-level=ERROR
Expand Down
6 changes: 5 additions & 1 deletion riscv-ffh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ endif::[]
[WARNING]
.This document is in the link:http://riscv.org/spec-state[Ratified state]
===
No changes are allowed. Any desired or needed changes can be the subject of a follow-on new extension. Ratified extensions are never revised
No changes are allowed. Any desired or needed changes can be the subject of a follow-on new extension. Ratified extensions are never revised.
[preface]
== Copyright and license information
This specification is licensed under the Creative Commons
Expand All @@ -64,6 +64,10 @@ include::contributors.adoc[]

* Initial version

==== Version 1.0.1

* Only print the specification state on the title page, not the entire text.

== Introduction

RISC-V systems which use Advanced Configuration and Power Interface (ACPI)
Expand Down

0 comments on commit 4d14faf

Please sign in to comment.