rename internal doc/ folders to docs/

This commit is contained in:
Mizux Seiha
2022-01-06 17:05:18 +01:00
parent 2e69bb2a95
commit 8d96a95479
28 changed files with 20 additions and 20 deletions

View File

@@ -24,7 +24,7 @@ Dockers [Alpine, Archlinux, Centos, Debian, Fedora, OpenSuse, Ubuntu]: [![Status
<a href="#compilation">Compilation</a> |
<a href="#testing">Testing</a> |
<a href="#integration">Integration</a> |
<a href="doc/ci.md">CI</a> |
<a href="docs/ci.md">CI</a> |
</nav>
OR-Tools comes with a Bazel based build ([WORKSPACE](../WORKSPACE)) that can be

View File

@@ -1,20 +1,19 @@
# CI: Makefile/Docker testing
To test the build on various distro, I'm using docker containers and a Makefile for orchestration.
pros:
* You are independent of third party CI runner config (e.g. github actions runners or Travis-CI VM images).
* You can run it locally on your linux system.
* Most CI provide runner with docker and Makefile installed (e.g. tarvis-ci [minimal images](https://docs.travis-ci.com/user/languages/minimal-and-generic/).
* You are independent of third party CI runner VM images (e.g. [github actions/virtual-environments](https://github.com/actions/virtual-environments)).
* You can run it locally on any host having a linux docker image support.
* Most CI provide runner with docker and Makefile installed.
cons:
* Only GNU/Linux distro supported.
* Could take few GiB (~30 GiB for all distro and all languages)
* ~500MiB OS + C++/CMake tools,
* ~150 MiB Python,
* ~400 MiB dotnet-sdk,
* ~400 MiB java-jdk.
# Usage
## Usage
To get the help simply type:
```sh
make
@@ -25,13 +24,14 @@ note: you can also use from top directory
make --directory=bazel
```
## Example
### Example
For example to test inside an `Ubuntu` container:
```sh
make ubuntu_test
```
# Docker Layers
## Docker Layers
Dockerfile is splitted in several stages.
![docker](docker.svg)

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

@@ -1,7 +1,7 @@
#/usr/bin/env bash
set -ex
#!/usr/bin/env bash
set -eux
rm -f *.svg *.png
rm -f ./*.svg ./*.png
for i in *.dot; do
#plantuml -Tpng "$i";
plantuml -Tsvg "$i";

View File

@@ -42,13 +42,13 @@ Dockers [Alpine, Archlinux, Centos, Debian, Fedora, OpenSuse, Ubuntu]x[C++, Pyth
<nav for="cmake"> |
<a href="#deps">Dependencies</a> |
<a href="#options">Options</a> |
<a href="doc/cpp.md">C++</a> |
<a href="doc/swig.md">Swig</a> |
<a href="doc/python.md">Python 3</a> |
<a href="doc/dotnet.md">.Net Core</a> |
<a href="doc/java.md">Java</a> |
<a href="docs/cpp.md">C++</a> |
<a href="docs/swig.md">Swig</a> |
<a href="docs/python.md">Python 3</a> |
<a href="docs/dotnet.md">.Net Core</a> |
<a href="docs/java.md">Java</a> |
<a href="#integration">Integration</a> |
<a href="doc/ci.md">CI</a> |
<a href="docs/ci.md">CI</a> |
</nav>
OR-Tools comes with a CMake based build ([CMakeLists.txt](../CMakeLists.txt))

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

@@ -41,7 +41,7 @@ Python, Java, .Net]: [![Status][docker_svg]][docker_link]
## Introduction
<nav for="make"> |
<a href="#deps">Dependencies</a> |
<a href="doc/ci.md">CI</a> |
<a href="docs/ci.md">CI</a> |
</nav>
OR-Tools comes with a GNU Make based build ([Makefile](../Makefile)) that can be

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB