From 14adb99c9a266f9d8fe651e57a6c4ec7dbd0f258 Mon Sep 17 00:00:00 2001 From: Derek Hower Date: Thu, 21 Mar 2024 10:53:34 -0400 Subject: [PATCH] Remove unused files Signed-off-by: Derek Hower --- Makefile | 71 ------------------------------------------- contributors.adoc | 1 + example.bib | 36 ---------------------- readme.adoc | 48 ++--------------------------- src/bibliography.adoc | 4 --- src/chapter2.adoc | 47 ---------------------------- src/contributors.adoc | 7 ----- src/header.adoc | 67 ---------------------------------------- src/index.adoc | 2 -- src/intro.adoc | 15 --------- 10 files changed, 3 insertions(+), 295 deletions(-) delete mode 100644 Makefile create mode 100644 contributors.adoc delete mode 100644 example.bib delete mode 100644 src/bibliography.adoc delete mode 100644 src/chapter2.adoc delete mode 100644 src/contributors.adoc delete mode 100644 src/header.adoc delete mode 100644 src/index.adoc delete mode 100644 src/intro.adoc diff --git a/Makefile b/Makefile deleted file mode 100644 index 3df8b68..0000000 --- a/Makefile +++ /dev/null @@ -1,71 +0,0 @@ -# Makefile for RISC-V Doc Template -# -# 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 Doc Template for RISC-V Extensions. - -DATE ?= $(shell date +%Y-%m-%d) -VERSION ?= v0.0.0 -REVMARK ?= Draft -DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \ -riscvintl/riscv-docs-base-container-image:latest - -SRC_DIR := src -BUILD_DIR := build -HEADER_SOURCE := $(SRC_DIR)/header.adoc -PDF_RESULT := $(BUILD_DIR)/spec-sample.pdf -HTML_RESULT := $(BUILD_DIR)/spec-sample.html - -ASCIIDOCTOR_PDF := asciidoctor-pdf -ASCIIDOCTOR_HTML := asciidoctor -OPTIONS := --trace \ - -a compress \ - -a mathematical-format=svg \ - -a revnumber=${VERSION} \ - -a revremark=${REVMARK} \ - -a revdate=${DATE} \ - -a pdf-fontsdir=docs-resources/fonts \ - -a pdf-theme=docs-resources/themes/riscv-pdf.yml \ - --failure-level=ERROR -REQUIRES := --require=asciidoctor-bibtex \ - --require=asciidoctor-diagram \ - --require=asciidoctor-mathematical - -.PHONY: all build clean build-container build-no-container - -all: build - -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..." - $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)" - $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE)" - @echo "Build completed successfully inside Docker container." - -build-no-container: - @echo "Starting build..." - $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE) - $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE) - @echo "Build completed successfully." - -clean: - @echo "Cleaning up generated files..." - rm -rf $(BUILD_DIR) - @echo "Cleanup completed." diff --git a/contributors.adoc b/contributors.adoc new file mode 100644 index 0000000..ee958f1 --- /dev/null +++ b/contributors.adoc @@ -0,0 +1 @@ + * Derek Hower (Qualcomm) diff --git a/example.bib b/example.bib deleted file mode 100644 index 4c368b1..0000000 --- a/example.bib +++ /dev/null @@ -1,36 +0,0 @@ -@inproceedings{riscI-isca1981, - title = {{RISC I}: {A} Reduced Instruction Set {VLSI} Computer}, - author = {David A. Patterson and Carlo H. S\'{e}quin}, - booktitle = {ISCA}, - location = {Minneapolis, Minnesota, USA}, - pages = {443-458}, - year = {1981} -} - -@inproceedings{Katevenis:1983, - author = {Manolis G.H. Katevenis and Robert W. Sherburne Jr. and David A. Patterson and Carlo H. S\'{e}quin}, - title = {The {RISC II} micro-architecture}, - booktitle = {Proceedings VLSI 83 Conference}, - year = {1983}, - month = {August} -} - -@inproceedings{Ungar:1984, - author = {David Ungar and Ricki Blau and Peter Foley and Dain Samples and David Patterson}, - title = {Architecture of {SOAR}: {Smalltalk} on a {RISC}}, - booktitle = {ISCA}, - address = {Ann Arbor, MI}, - year = {1984}, - pages = {188-197} -} - -@article{spur-jsscc1989, - author = {David D. Lee and Shing I. Kong and Mark D. Hill and George S. Taylor and David A. Hodges and Randy H. Katz and David A. Patterson}, - title = {A {VLSI} Chip Set for a Multiprocessor Workstation--{Part I}: An {RISC} Microprocessor with Coprocessor Interface and Support for Symbolic Processing}, - journal = {IEEE JSSC}, - year = {1989}, - volume = {24}, - number = {6}, - pages = {1688-1698}, - month = {December} -} diff --git a/readme.adoc b/readme.adoc index 87b7626..e480a50 100644 --- a/readme.adoc +++ b/readme.adoc @@ -1,4 +1,4 @@ -= RISC-V Combined Instructions SIG += RISC-V Scalar Efficiency SIG == License @@ -6,56 +6,12 @@ This work is licensed under a Creative Commons Attribution 4.0 International Lic == Contributors -The list of contributors to this specification is maintained in the link:src/contributors.adoc[contributors] file. +The list of contributors to this specification is maintained in the link:contributors.adoc[contributors] file. For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] 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, asciidoctor-bibtex, asciidoctor-diagram, and asciidoctor-mathematical -* Docker - === Cloning the Repository ```shell git clone --recurse-submodules https://github.com/riscv-admin/riscv-combined-instructions.git ``` - -=== Building the Documentation - -To start the build process, run: - -```shell -cd ./riscv-combined-instructions && 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 -``` diff --git a/src/bibliography.adoc b/src/bibliography.adoc deleted file mode 100644 index 4cc3eb7..0000000 --- a/src/bibliography.adoc +++ /dev/null @@ -1,4 +0,0 @@ -[bibliography] -== Bibliography - -bibliography::[] diff --git a/src/chapter2.adoc b/src/chapter2.adoc deleted file mode 100644 index 8c11820..0000000 --- a/src/chapter2.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[[chapter2]] -== The Second Chapter - -. The first item. - -. The second item. -+ -.. The first sub item. - -.. The second sub item. -+ -[CAUTION] -==== -A moment of caution is required for this block of text must be read and apreciated for its importance. -==== - -. Yet another item. - -. Again, an item. - -.. A multi-line item. -+ -This item has multiple lines. -+ -By multiple lines, this is what we mean. -+ -Seriously, multiple. - -=== An example table - -[cols="^1,^1,^1,^1,^3,^3",stripes=even,options="header"] -|=== -4+|Letters _and_ bits {set:cellbgcolor:green} 2+|A much longer area -|L|R|W|X|Quarter 1|Quarter 2 -|{set:cellbgcolor:!} 0|0|0|0 2+|Rows alternate colors -|0|0|0|1|Thing 1|Thing 2 -|1|0|0|0|Thing 3|Thing 4 -|1|1|1|1 2+|Span Thing 1 and 2 -|=== - -=== Sub section - -Diam donec adipiscing tristique risus indexterm:[risus]. Nisl rhoncus mattis rhoncus urna. Egestas egestas fringilla phasellus faucibus scelerisque eleifend donec pretium vulputate. Porta non pulvinar neque laoreet suspendisse interdum consectetur libero id. Massa vitae tortor condimentum lacinia quis vel. Donec ac odio tempor orci. Mi sit amet mauris commodo quis imperdiet massa tincidunt. Quis enim lobortis scelerisque fermentum dui. Lacus viverra vitae congue eu. Sed faucibus turpis in eu mi bibendum neque. Sit amet porttitor eget dolor. Aliquet eget sit amet tellus cras adipiscing enim. Id cursus metus aliquam eleifend mi. Vestibulum lorem sed risus ultricies tristique nulla aliquet. - -=== Yet another subsection - -Quam lacus suspendisse faucibus interdum posuere lorem ipsum. Nulla aliquet enim tortor at auctor urna nunc id cursus. Massa massa ultricies mi quis hendrerit dolor magna. Integer enim neque volutpat ac tincidunt. Dolor magna eget est lorem ipsum dolor. Urna neque viverra justo nec. Neque gravida in fermentum et. Fringilla ut morbi tincidunt augue interdum velit euismod. Dolor sit amet consectetur adipiscing elit. Eu facilisis sed odio morbi. In cursus turpis massa tincidunt dui. Orci indexterm:[orci] phasellus egestas tellus rutrum tellus. Semper eget duis at tellus at urna condimentum. Orci porta non pulvinar neque laoreet suspendisse interdum consectetur. diff --git a/src/contributors.adoc b/src/contributors.adoc deleted file mode 100644 index 13fd776..0000000 --- a/src/contributors.adoc +++ /dev/null @@ -1,7 +0,0 @@ -== Contributors - -This RISC-V specification has been contributed to directly or indirectly by: - -[%hardbreaks] -* Author1 -* Author2 diff --git a/src/header.adoc b/src/header.adoc deleted file mode 100644 index 53e3e07..0000000 --- a/src/header.adoc +++ /dev/null @@ -1,67 +0,0 @@ -= RISC-V Example Specification Document (Zexmpl) -Authors: Author 1, Author 2 -:docgroup: RISC-V Task Group -:description: RISC-V Example Specification Document (Zexmpl) -:company: RISC-V.org -:revdate: 1/2023 -:revnumber: 1.0 -:revremark: This document is under development. Expect potential changes. Visit http://riscv.org/spec-state for further details. -:revinfo: -:url-riscv: http://riscv.org -:doctype: book -:preface-title: Preamble -:colophon: -:appendix-caption: Appendix -// https://docs.asciidoctor.org/asciidoc/latest/macros/images-directory/ -:imagesdir: ../docs-resources/images -:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center] -// Settings: -:experimental: -:reproducible: -//:WaveDromEditorApp: app/wavedrom-editor.app -:imagesoutdir: ../build/images -:bibtex-file: example.bib -:bibtex-order: alphabetical -:bibtex-style: apa -:icons: font -:lang: en -:listing-caption: Listing -:sectnums: -:toc: left -:toclevels: 4 -:source-highlighter: pygments -ifdef::backend-pdf[] -:source-highlighter: coderay -endif::[] -:data-uri: -:hide-uri-scheme: -:stem: latexmath -:footnote: -:xrefstyle: short - -[WARNING] -.This document is in the link:http://riscv.org/spec-state[Development state] -==== -Expect potential changes. This draft specification is likely to evolve before -it is accepted as a standard. Implementations based on this draft -may not conform to the future standard. -==== - -[preface] -== Copyright and license information -This specification is licensed under the Creative Commons -Attribution 4.0 International License (CC-BY 4.0). The full -license text is available at -https://creativecommons.org/licenses/by/4.0/. - -Copyright 2023 by RISC-V International. - -[preface] -include::contributors.adoc[] - -include::intro.adoc[] -include::chapter2.adoc[] - -// The index must precede the bibliography -include::index.adoc[] -include::bibliography.adoc[] diff --git a/src/index.adoc b/src/index.adoc deleted file mode 100644 index 4abaca2..0000000 --- a/src/index.adoc +++ /dev/null @@ -1,2 +0,0 @@ -[index] -== Index diff --git a/src/intro.adoc b/src/intro.adoc deleted file mode 100644 index 0d62327..0000000 --- a/src/intro.adoc +++ /dev/null @@ -1,15 +0,0 @@ -[[intro]] -== Introduction - -Lorem ipsum indexterm:[Lorem ipsum] dolor sit amet, consectetur adipiscing elit, sed do *eiusmod tempor* incididunt ut labore et dolore magna aliqua. Felis imperdiet proin fermentum leo vel orci porta. Volutpat lacus laoreet non curabitur indexterm:[curabitur] gravida indexterm:[gravida]. Posuere urna nec tincidunt praesent semper feugiat nibh. Elit ``ullamcorper`` dignissim cras tincidunt lobortis. Malesuada fames ac turpis egestas integer eget. Tristique sollicitudin nibh sit amet commodo. Sed felis eget velit aliquet. Sit amet aliquam id diam maecenas ultricies mi. Consectetur purus ut faucibus pulvinar. Lectus urna duis convallis convallis tellus id. Fermentum iaculis eu non diam. Feugiat in fermentum posuere urna nec tincidunt praesent semper feugiat. Urna nec tincidunt praesent semper feugiat nibh. - -Commodo viverra maecenas accumsan lacus. Vulputate odio ut enim blandit indexterm:[blandit] volutpat maecenas volutpat blandit. Urna porttitor rhoncus dolor purus non. Tellus mauris a diam maecenas sed. Vitae auctor eu augue ut lectus. Ridiculus mus mauris vitae ultricies leo integer. Consequat semper viverra nam *libero* justo laoreet sit amet. Pellentesque pulvinar pellentesque habitant morbi tristique senectus et netus et. Ac placerat vestibulum lectus mauris ``ultrices`` eros in cursus turpis. Accumsan in nisl nisi scelerisque eu ultrices vitae. Cras ornare arcu dui vivamus. Vitae congue mauris rhoncus aenean. Consequat mauris nunc congue nisi vitae suscipit tellus. Tempus egestas sed sed risus pretium quam vulputate dignissim. Quis varius quam quisque id diam vel. Mattis nunc sed blandit libero volutpat sed cras ornare arcu. Amet mauris commodo quis imperdiet massa tincidunt nunc. - -[NOTE] -==== -The name RISC-V indexterm:[RISC-V] was chosen to represent the fifth major RISC ISA design from UC Berkeley (RISC-I cite:[riscI-isca1981], RISC-II cite:[Katevenis:1983], SOAR cite:[Ungar:1984], and SPUR cite:[spur-jsscc1989] were the first four). We also pun on the use of the Roman numeral "V" to signify "variations" and "vectors", as support for a range of architecture research, including various data-parallel accelerators, is an explicit goal of the ISA design. -==== - -=== Sub Section of Introduction - -Pellentesque habitant morbi *tristique* senectus et netus et. Aliquam purus sit amet luctus. Odio eu ``feugiat`` pretium nibh ipsum consequat nisl vel. Euismod lacinia at quis risus sed vulputate odio ut. Eu sem integer vitae justo eget. Cursus euismod quis viverra nibh. Tempus egestas sed sed risus. Quis imperdiet massa tincidunt nunc pulvinar. Id venenatis a condimentum vitae sapien pellentesque habitant.