Migration to RISC-V specifications template in asciidoc

apazos · cmuellner · commit e57d6169a2ef · 2024-08-28T14:03:09.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/build/*
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs-resources"]
+	path = docs-resources
+	url = https://github.com/riscv/docs-resources.git
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,26 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-json
+      - id: check-symlinks
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: local
+    hooks:
+      - id: forbidden-file-extensions
+        name: forbidden-file-extensions
+        entry: disallow these file extensions
+        language: fail
+        # Disallow other asciidoc extensions except .adoc
+        files: .*\.(asciidoc|asc)$
+
+  - repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
+    rev: 0.2.3
+    hooks:
+      - id: yamlfmt
+        args: [--mapping, '2', --sequence, '4', --offset, '2']
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+# RISC-V Code of Conduct
+All RISC-V International projects are governed by the RISC-V Code of Conduct found at https://riscv.org/community/community-code-of-conduct/.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,58 @@
+# Contribution Guidelines
+
+As an open-source project, we appreciate and encourage community members to submit patches directly to the project. To maintain a well-organized development environment, we have established standards and methods for submitting changes. This document outlines the process for submitting patches to the project, ensuring that your contribution is swiftly incorporated into the codebase.
+
+# Licensing
+
+Licensing is crucial for open-source projects, as it guarantees that the software remains available under the conditions specified by the author.
+
+This project employs the Creative Commons Attribution 4.0 International license, which can be found in the LICENSE file within the project's repository.
+
+Licensing defines the rights granted to you as an author by the copyright holder. It is essential for contributors to fully understand and accept these licensing rights. In some cases, the copyright holder may not be the contributor, such as when the contributor is working on behalf of a company.
+
+# Developer Certificate of Origin (DCO)
+To uphold licensing criteria and demonstrate good faith, this project mandates adherence to the Developer Certificate of Origin (DCO) process.
+
+The DCO is an attestation appended to every contribution from each author. In the commit message of the contribution (explained in greater detail later in this document), the author adds a Signed-off-by statement, thereby accepting the DCO.
+
+When an author submits a patch, they affirm that they possess the right to submit the patch under the designated license. The DCO agreement is displayed below and at https://developercertificate.org.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b), or (c), and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+
+# DCO Sign-Off Methods
+The DCO necessitates the inclusion of a sign-off message in the following format for each commit within the pull request:
+
+Signed-off-by: Stephano Cetola <scetola@linuxfoundation.org>
+
+Please use your real name in the sign-off message.
+
+You can manually add the DCO text to your commit body or include either -s or --signoff in your standard Git commit commands. If you forget to incorporate the sign-off, you can also amend a previous commit with the sign-off by executing git commit --amend -s. If you have already pushed your changes to GitHub, you will need to force push your branch afterward using git push -f.
+
+Note:
+
+Ensure that the name and email address associated with your GitHub account match the name and email address in the Signed-off-by line of your commit message.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -0,0 +1,8 @@
+# Governance
+This project is governed by the Toolchains SIG.
+
+The group can be joined by RISC-V members at: https://lists.riscv.org/g/sig-toolchains.
+
+Mailing list archives are available at: https://lists.riscv.org/g/sig-toolchains/topics.
+
+Community meetings schedule at: https://tech.riscv.org/calendar.
diff --git a/LICENSE b/LICENSE
@@ -49,7 +49,7 @@ exhaustive, and do not form part of our licenses.
      such as asking that all changes be marked or described.
      Although not required by our licenses, you are encouraged to
      respect those requests where reasonable. More_considerations
-     for the public: 
+     for the public:
 	wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1,5 @@
+# Maintainers
+This project is maintained by the following people:
+
+- Christoph Müllner ([cmuellner](https://github.com/cmuellner))
+- Ana Pazos ([apazos](https://github.com/apazos))
diff --git a/Makefile b/Makefile
@@ -0,0 +1,88 @@
+# Makefile for RISC-V C API Specification.
+#
+# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+# International License. To view a copy of this license, visit
+# http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
+# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+#
+# Description:
+#
+# This Makefile is designed to automate the process of building and packaging
+# the RISC-V C API Specification.
+
+DOCS := \
+	riscv-c-api.adoc
+
+DATE ?= $(shell date +%Y-%m-%d)
+DOCKER_IMG := riscvintl/riscv-docs-base-container-image:latest
+
+ifneq ($(SKIP_DOCKER),true)
+	DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \
+	${DOCKER_IMG} \
+	/bin/sh -c
+	DOCKER_QUOTE := "
+endif
+
+SRC_DIR := src
+BUILD_DIR := build
+
+DOCS_PDF := $(DOCS:%.adoc=%.pdf)
+DOCS_HTML := $(DOCS:%.adoc=%.html)
+
+XTRA_ADOC_OPTS :=
+ASCIIDOCTOR_PDF := asciidoctor-pdf
+ASCIIDOCTOR_HTML := asciidoctor
+OPTIONS := --trace \
+           -a compress \
+           -a revdate=${DATE} \
+           -a pdf-style=docs-resources/themes/risc-v_spec-pdf.yml \
+           -a pdf-fontsdir=docs-resources/fonts \
+           $(XTRA_ADOC_OPTS) \
+		   -D build \
+           --failure-level=ERROR
+REQUIRES := --require=asciidoctor-lists
+
+.PHONY: all build clean build-container build-no-container build-docs
+
+all: build
+
+build-docs: $(DOCS_PDF) $(DOCS_HTML)
+
+vpath %.adoc $(SRC_DIR)
+
+%.pdf: %.adoc
+	$(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE)
+
+%.html: %.adoc
+	$(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE)
+
+build:
+	@echo "Checking if Docker is available..."
+	@if command -v docker >/dev/null 2>&1 ; then \
+		echo "Docker is available, building inside Docker container..."; \
+		$(MAKE) build-container; \
+	else \
+		echo "Docker is not available, building without Docker..."; \
+		$(MAKE) build-no-container; \
+	fi
+
+build-container:
+	@echo "Starting build inside Docker container..."
+	$(MAKE) build-docs
+	@echo "Build completed successfully inside Docker container."
+
+build-no-container:
+	@echo "Starting build..."
+	$(MAKE) SKIP_DOCKER=true build-docs
+	@echo "Build completed successfully."
+
+# Update docker image to latest
+docker-pull-latest:
+	docker pull ${DOCKER_IMG}
+
+clean:
+	@echo "Cleaning up generated files..."
+	rm -rf $(BUILD_DIR)
+	@echo "Cleanup completed."
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,107 @@
+= RISC-V C API Specification
+
+== License
+
+This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). For details, see the link:LICENSE[LICENSE] file.
+
+== Maintainers
+
+The list of maintainers of this specification is maintained in the link:MAINTAINERS.md[MAINTAINERS] file.
+
+== Contributors
+
+The list of contributors to this specification is maintained in the link:src/contributors.adoc[contributors] file.
+
+For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] file.
+
+== Governance
+
+The governance for this project is defined in the link:GOVERNANCE.md[GOVERNANCE] file.
+
+Community information, including meeting (if held) and mailing lists are detailed in this file.
+
+== Building the Document
+
+=== Directory Structure
+
+The following directories are used to organize the contents of this repo:
+
+* `dependencies/`: software dependencies needed to build the specification
+* `docs-resources/`: resources for all specifications sourced from link:.gitmodules[git submodule]
+* `src/`: source files for the specification
+* `build/`: default directory where the build artifacts are generated
+
+=== Prerequisites
+
+To build the document, you'll need the following tools installed on your system:
+
+* Make
+* asciiDoctor-pdf
+* Docker
+
+=== Cloning the Repository
+
+```shell
+git clone --recurse-submodules https://github.com/riscv-non-isa/riscv-c-api-doc.git
+```
+
+All in one single line:
+
+```shell
+git clone --recurse-submodules  https://github.com/riscv-non-isa/riscv-c-api-doc.git && cd riscv-c-api-doc && git submodule update --init --recursive
+
+```
+
+=== Building the Documentation
+
+To start the build process, run:
+
+```shell
+cd ./riscv-c-api-doc && make build
+```
+
+The link:Makefile[] script will check the availability of Docker on your system:
+
+* If Docker is available, the documentation will be built inside a Docker container using the image riscvintl/riscv-docs-base-container-image:latest. This ensures a consistent build environment across different systems.
+* If Docker is not available, the documentation will be built directly on your system using the installed tools.
+
+The documentation is generated from the AsciiDoctor source files in your project. The primary source file is specified by the `HEADER_SOURCE` variable in the Makefile.
+
+The build process utilizes several options, including theming and font settings, and generates a PDF document as output.
+
+=== Cleaning up
+
+To clean up the generated files, run:
+
+```shell
+make clean
+```
+
+== Enabling pre-commit checks locally
+
+The repository has some basic commit checks set up with https://pre-commit.com/[pre-commit] that will be enforced by the GitHub CI.
+To ensure these checks are also run in the local repository while making changes the following can be done:
+
+.Installing pre-commit tool
+[source,shell]
+----
+# Do once on your system
+pip3 install pre-commit
+----
+
+.Installing pre-commit git hook in repo
+[source,shell]
+----
+# Do once in local repo
+pre-commit install
+----
+
+Rather than doing the above `pre-commit install` in every repo that uses it, you can do it https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories[once on your system.]
+
+When enabling additional checks https://pre-commit.com/#plugins[by editing .pre-commit-config.yaml], it is recommended running the newly added check on all files in the repository. This can be done with the following command:
+
+.Running all pre-commit hooks on all files
+[source,shell]
+----
+pre-commit run --all-files
+----
diff --git a/docs-resources b/docs-resources
@@ -0,0 +1 @@
+Subproject commit 35203a4f123d0be162b6b5ea213a657b594f8c36
diff --git a/riscv-c-api.md b/riscv-c-api.md
diff --git a/src/c-api.adoc b/src/c-api.adoc
diff --git a/src/contributors.adoc b/src/contributors.adoc
diff --git a/src/preamble.adoc b/src/preamble.adoc
diff --git a/src/prelude.adoc b/src/prelude.adoc
diff --git a/src/riscv-c-api.adoc b/src/riscv-c-api.adoc

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "docs-resources"]`
	`2`	`+ path = docs-resources`
	`3`	`+ url = https://github.com/riscv/docs-resources.git`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# RISC-V Code of Conduct`
	`2`	`+All RISC-V International projects are governed by the RISC-V Code of Conduct found at https://riscv.org/community/community-code-of-conduct/.`