Menu
▾
▴
[cadcdev-svn-commits] [SCM] branch master updated. v2.0.0-982-g228b0c0
|
From: darcagn <da...@us...> - 2023-07-14 18:47:09
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "A pseudo Operating System for the Dreamcast.".
The branch, master has been updated
via 228b0c04d51cffac0c277dde7cf781c8dde43b32 (commit)
from 413df90b79485f3b86696af67cf145e5adea1a2e (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 228b0c04d51cffac0c277dde7cf781c8dde43b32
Author: Accelerator <mr....@gm...>
Date: Fri Jul 14 20:45:30 2023 +0200
Formatting Fixes and Markdown Normalization in dc-chain Directory (#253)
* triple backticks for blocks in dc-load markdown files
* update macos doc ./cleanup.sh -> make clean
* quick fix on format
-----------------------------------------------------------------------
Summary of changes:
utils/dc-chain/README.md | 18 +++++-----
utils/dc-chain/doc/bsd/README.md | 60 ++++++++++++++++-----------------
utils/dc-chain/doc/cygwin/README.md | 35 ++++++++++----------
utils/dc-chain/doc/linux/alpine.md | 54 +++++++++++++++---------------
utils/dc-chain/doc/linux/debian.md | 55 ++++++++++++++++---------------
utils/dc-chain/doc/macos/README.md | 54 +++++++++++++++---------------
utils/dc-chain/doc/mingw/README.md | 6 ++--
utils/dc-chain/doc/mingw/mingw-w64.md | 62 +++++++++++++++++------------------
utils/dc-chain/doc/mingw/mingw.md | 48 +++++++++++++--------------
utils/dc-chain/patches/README.md | 16 ++++-----
10 files changed, 205 insertions(+), 203 deletions(-)
diff --git a/utils/dc-chain/README.md b/utils/dc-chain/README.md
index 9a9c0ba..d645a82 100644
--- a/utils/dc-chain/README.md
+++ b/utils/dc-chain/README.md
@@ -273,9 +273,9 @@ Below you will find some generic instructions; you may find some specific
instructions in the `./doc` directory for your environment.
In the dc-chain directory, run (for **BSD**, please use `gmake` instead):
-
- make
-
+```
+make
+```
This will build the ARM & SH4 toolchains. If you wish to only build the SH4
toolchain and just use the prebuilt KOS sound driver run:
make build-sh4
@@ -289,9 +289,9 @@ If anything goes wrong, check the output in `logs/`.
For the `sh-elf` toolchain, if you want to use the **GNU Debugger** (`gdb`),
you can make it by entering:
-
- make gdb
-
+```
+make gdb
+```
This will install `gdb` in the `sh-elf` toolchain. `gdb` is used with
`dcload/dc-tool` programs, which are part of **KallistiOS** too, in order to do
remote debugging of your **Dreamcast** programs. Please read the `dcload`
@@ -300,9 +300,9 @@ documentation to learn more on this point.
### Removing all useless files
After the toolchain compilation, you can cleanup everything by entering:
-
- make clean
-
+```
+make clean
+```
This will save a lot of space by removing all unnecessary files.
## Final note
diff --git a/utils/dc-chain/doc/bsd/README.md b/utils/dc-chain/doc/bsd/README.md
index a471f97..ffbc996 100644
--- a/utils/dc-chain/doc/bsd/README.md
+++ b/utils/dc-chain/doc/bsd/README.md
@@ -18,9 +18,9 @@ do this before continuing reading the document.
All the operations in this document should be executed with the `root` user. If
you don't want to connect with the `root` user, another option is to install
the `sudo` command by entering:
-
- pkg install sudo
-
+```
+pkg install sudo
+```
In that case, you will need to add the `sudo` command before entering all the
commands specified below.
@@ -32,9 +32,9 @@ build the whole toolchains.
### Installation of required packages ###
The packages below need to be installed:
-
- pkg install gcc gmake binutils texinfo bash libjpeg-turbo png libelf
-
+```
+pkg install gcc gmake binutils texinfo bash libjpeg-turbo png libelf
+```
In **BSD** systems, the `make` is **NOT** the same as the **GNU Make** tool.
Everything in the package needs `gmake`, you can't use `make` in **BSD**
systems.
@@ -45,9 +45,9 @@ needs `bash`, that's why it needs to be installed.
### Installation of additional packages ###
These additional packages are required too:
-
- pkg install git subversion python2
-
+```
+pkg install git subversion python2
+```
**Git** is needed right now, as **Subversion Client** and **Python 2** will be
needed only when building `kos-ports`. But it's better to install these now.
@@ -55,21 +55,21 @@ By the way you can check the installation success by entering something like
`git --version`. This should returns something like `git version X.Y.Z`.
A cool text editor should be useful too:
-
- pkg install nano
-
+```
+pkg install nano
+```
Of course, this step is optional, you can use `vi` or something else if you
want.
## Preparing the environment installation ##
Enter the following to prepare **KallistiOS** and the toolchains:
-
- mkdir -p /opt/toolchains/dc/
- cd /opt/toolchains/dc/
- git clone git://git.code.sf.net/p/cadcdev/kallistios kos
- git clone git://git.code.sf.net/p/cadcdev/kos-ports
-
+```
+mkdir -p /opt/toolchains/dc/
+cd /opt/toolchains/dc/
+git clone git://git.code.sf.net/p/cadcdev/kallistios kos
+git clone git://git.code.sf.net/p/cadcdev/kos-ports
+```
Everything is ready, now it's time to make the toolchains.
## Compilation ##
@@ -86,35 +86,35 @@ the main `README.md` file at the root for more information.
To make the toolchains, do the following:
1. Run `bash`, if not already done:
-
- bash
-
+ ```
+ bash
+ ```
2. Navigate to the `dc-chain` directory by entering:
cd /opt/toolchains/dc/kos/utils/dc-chain/
3. Enter the following to start downloading and building toolchain:
-
- gmake
-
+ ```
+ gmake
+ ```
Now it's time to take a coffee as this process is really long: several hours
will be needed to make the full toolchains!
### Making the GNU Debugger (gdb) ###
If you want to install the **GNU Debugger** (`gdb`), just enter:
-
- gmake gdb
-
+```
+gmake gdb
+```
This will install `sh-elf-gdb` and can be used to debug programs through
`dc-load/dc-tool`.
### Removing all useless files ###
After everything is done, you can cleanup all temporary files by entering:
-
- gmake clean
-
+```
+gmake clean
+```
## Next steps ##
After following this guide, the toolchains should be ready.
diff --git a/utils/dc-chain/doc/cygwin/README.md b/utils/dc-chain/doc/cygwin/README.md
index 00c6900..fa32c51 100644
--- a/utils/dc-chain/doc/cygwin/README.md
+++ b/utils/dc-chain/doc/cygwin/README.md
@@ -81,11 +81,12 @@ whole environment to build the toolchains.
file).
2. Enter the following to prepare **KallistiOS**:
-
- mkdir -p /opt/toolchains/dc/
- cd /opt/toolchains/dc/
- git clone git://git.code.sf.net/p/cadcdev/kallistios kos
- git clone git://git.code.sf.net/p/cadcdev/kos-ports
+ ```
+ mkdir -p /opt/toolchains/dc/
+ cd /opt/toolchains/dc/
+ git clone git://git.code.sf.net/p/cadcdev/kallistios kos
+ git clone git://git.code.sf.net/p/cadcdev/kos-ports
+ ```
Everything is ready, now it's time to make the toolchains.
@@ -105,31 +106,31 @@ To make the toolchains, do the following:
1. Start the **Cygwin Terminal** if not already done.
2. Navigate to the `dc-chain` directory by entering:
-
- cd /opt/toolchains/dc/kos/utils/dc-chain/
-
+ ```
+ cd /opt/toolchains/dc/kos/utils/dc-chain/
+ ```
3. Enter the following to start downloading and building toolchain:
-
- make
-
+ ```
+ make
+ ```
Now it's time to take a coffee as this process is really long: several hours
will be needed to make the full toolchains!
### Making the GNU Debugger (gdb) ###
If you want to install the **GNU Debugger** (`gdb`), just enter:
-
- make gdb
-
+```
+make gdb
+```
This will install `sh-elf-gdb` and can be used to debug programs through
`dc-load/dc-tool`.
### Removing all useless files ###
After everything is done, you can cleanup all temporary files by entering:
-
- make clean
-
+```
+make clean
+```
## Next steps ##
After following this guide, the toolchains should be ready.
diff --git a/utils/dc-chain/doc/linux/alpine.md b/utils/dc-chain/doc/linux/alpine.md
index 1d1bddb..2e9d14b 100644
--- a/utils/dc-chain/doc/linux/alpine.md
+++ b/utils/dc-chain/doc/linux/alpine.md
@@ -28,23 +28,23 @@ build the whole toolchains.
### Installation of required packages ###
The packages below need to be installed:
-
- apk --update add build-base patch bash texinfo libjpeg-turbo-dev libpng-dev curl wget
-
+```
+apk --update add build-base patch bash texinfo libjpeg-turbo-dev libpng-dev curl wget
+```
At this time of writing, the `libelf-dev` package was missing from the main
repository, so you have to execute the following to install it:
-
- apk --update add libelf-dev --repository=http://dl-cdn.alpinelinux.org/alpine/v3.9/main
-
+```
+apk --update add libelf-dev --repository=http://dl-cdn.alpinelinux.org/alpine/v3.9/main
+```
This may not be necessary depending if the `apk` repository was updated. Please
keep in mind that you have to install the `libelf-dev` package.
### Installation of additional packages ###
These additional packages are required too:
-
- apk --update add git python subversion
-
+```
+apk --update add git python subversion
+```
**Git** is needed right now, as **Subversion Client** and **Python 2** will be
needed only when building `kos-ports`. But it's better to install these now.
@@ -54,12 +54,12 @@ By the way you can check the installation success by entering something like
## Preparing the environment installation ##
Enter the following to prepare **KallistiOS** and the toolchains:
-
- mkdir -p /opt/toolchains/dc/
- cd /opt/toolchains/dc/
- git clone git://git.code.sf.net/p/cadcdev/kallistios kos
- git clone git://git.code.sf.net/p/cadcdev/kos-ports
-
+```
+mkdir -p /opt/toolchains/dc/
+cd /opt/toolchains/dc/
+git clone git://git.code.sf.net/p/cadcdev/kallistios kos
+git clone git://git.code.sf.net/p/cadcdev/kos-ports
+```
Everything is ready, now it's time to make the toolchains.
## Compilation ##
@@ -76,31 +76,31 @@ the main `README.md` file at the root for more information.
To make the toolchains, do the following:
1. Navigate to the `dc-chain` directory by entering:
-
- cd /opt/toolchains/dc/kos/utils/dc-chain/
-
+ ```
+ cd /opt/toolchains/dc/kos/utils/dc-chain/
+ ```
2. Enter the following to start downloading and building toolchain:
-
- make
-
+ ```
+ make
+ ```
Now it's time to take a coffee as this process is really long: several hours
will be needed to make the full toolchains!
### Making the GNU Debugger (gdb) ###
If you want to install the **GNU Debugger** (`gdb`), just enter:
-
- make gdb
-
+```
+make gdb
+```
This will install `sh-elf-gdb` and can be used to debug programs through
`dc-load/dc-tool`.
### Removing all useless files ###
After everything is done, you can cleanup all temporary files by entering:
-
- ./cleanup.sh
-
+```
+./cleanup.sh
+```
## Next steps ##
After following this guide, the toolchains should be ready.
diff --git a/utils/dc-chain/doc/linux/debian.md b/utils/dc-chain/doc/linux/debian.md
index 0e3762f..2dc95ce 100644
--- a/utils/dc-chain/doc/linux/debian.md
+++ b/utils/dc-chain/doc/linux/debian.md
@@ -27,24 +27,25 @@ build the whole toolchains.
### Update of your local installation ###
The first thing to do is to update your local installation:
-
- apt-get update
- apt-get upgrade -y
-
+```
+apt-get update
+apt-get upgrade -y
+```
This should update all the packages of the **Debian** environment.
### Installation of required packages ###
The packages below need to be installed:
-
- apt-get install build-essential texinfo libjpeg-dev libpng-dev libelf-dev
+```
+apt-get install build-essential texinfo libjpeg-dev libpng-dev libelf-dev
+```
### Installation of additional packages ###
These additional packages are required too:
-
- apt-get install git subversion python
-
+```
+apt-get install git subversion python
+```
**Git** is needed right now, as **Subversion Client** and **Python 2** will be
needed only when building `kos-ports`. But it's better to install these now.
@@ -54,12 +55,12 @@ By the way you can check the installation success by entering something like
## Preparing the environment installation ##
Enter the following to prepare **KallistiOS** and the toolchains:
-
- mkdir -p /opt/toolchains/dc/
- cd /opt/toolchains/dc/
- git clone git://git.code.sf.net/p/cadcdev/kallistios kos
- git clone git://git.code.sf.net/p/cadcdev/kos-ports
-
+```
+mkdir -p /opt/toolchains/dc/
+cd /opt/toolchains/dc/
+git clone git://git.code.sf.net/p/cadcdev/kallistios kos
+git clone git://git.code.sf.net/p/cadcdev/kos-ports
+```
Everything is ready, now it's time to make the toolchains.
## Compilation ##
@@ -76,31 +77,31 @@ the main `README.md` file at the root for more information.
To make the toolchains, do the following:
1. Navigate to the `dc-chain` directory by entering:
-
- cd /opt/toolchains/dc/kos/utils/dc-chain/
-
+ ```
+ cd /opt/toolchains/dc/kos/utils/dc-chain/
+ ```
2. Enter the following to start downloading and building toolchain:
-
- make
-
+ ```
+ make
+ ```
Now it's time to take a coffee as this process is really long: several hours
will be needed to make the full toolchains!
### Making the GNU Debugger (gdb) ###
If you want to install the **GNU Debugger** (`gdb`), just enter:
-
- make gdb
-
+```
+make gdb
+```
This will install `sh-elf-gdb` and can be used to debug programs through
`dc-load/dc-tool`.
### Removing all useless files ###
After everything is done, you can cleanup all temporary files by entering:
-
- make clean
-
+```
+make clean
+```
## Next steps ##
After following this guide, the toolchains should be ready.
diff --git a/utils/dc-chain/doc/macos/README.md b/utils/dc-chain/doc/macos/README.md
index 35f86b7..abdb542 100644
--- a/utils/dc-chain/doc/macos/README.md
+++ b/utils/dc-chain/doc/macos/README.md
@@ -43,9 +43,9 @@ Please note, you can ignore these instructions below if you already have
1. Open a **Terminal**.
2. Then input:
-
- xcode-select --install
-
+ ```
+ xcode-select --install
+ ```
3. When the window opens, click on the `Install` button, then click on the
`Accept` button.
@@ -64,30 +64,30 @@ here to fill this gap:
1. Open a **Terminal** window.
2. Execute the following:
-
- /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
+ ```
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+ ```
**Homebrew** is now installed. You can check if it's working by entering
`brew --version`.
### Installation of required packages ###
The packages below need to be installed:
-
- brew install libjpeg libpng libelf
-
+```
+brew install libjpeg libpng libelf
+```
All the other required packages have already been installed, i.e. `git`, `svn`
or `python`.
## Preparing the environment installation ##
Enter the following to prepare **KallistiOS** and the toolchains:
-
- mkdir -p /opt/toolchains/dc/
- cd /opt/toolchains/dc/
- git clone git://git.code.sf.net/p/cadcdev/kallistios kos
- git clone git://git.code.sf.net/p/cadcdev/kos-ports
-
+```
+mkdir -p /opt/toolchains/dc/
+cd /opt/toolchains/dc/
+git clone git://git.code.sf.net/p/cadcdev/kallistios kos
+git clone git://git.code.sf.net/p/cadcdev/kos-ports
+```
Everything is ready, now it's time to make the toolchains.
## Compilation ##
@@ -104,31 +104,31 @@ the main `README.md` file at the root for more information.
To make the toolchains, do the following:
1. Navigate to the `dc-chain` directory by entering:
-
- cd /opt/toolchains/dc/kos/utils/dc-chain/
-
...<truncated>...
hooks/post-receive
--
A pseudo Operating System for the Dreamcast.
|
