Skip to content

Commit

Permalink
Add Jenkins pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
wallento committed Oct 20, 2019
1 parent b715a25 commit 194a490
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 38 deletions.
37 changes: 37 additions & 0 deletions Jenkinsfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
pipeline {
agent any

stages {
stage('Prepare env') {
steps {
withPythonEnv('python') {
sh 'pip install -r src/requirements.txt'
}
}
}
stage('Build B3 Specification') {
steps {
withPythonEnv('python') {
sh 'make -C src/b3 html latexpdf'
}
}
}
stage('Build B3.1 Specification') {
steps {
withPythonEnv('python') {
sh 'make -C src/b3.1 html latexpdf'
}
}
}
stage('Publish Website') {
steps {
sh 'rsync -avh --delete website/ /var/www/html/wishbone'
sh 'mkdir /var/www/html/wishbone/assets /var/www/html/wishbone/specs'
sh 'cp src/b3/build/latex/wishbone-b3.pdf /var/www/html/wishbone/assets'
sh 'cp src/b3.1/build/latex/wishbone-b3-1.pdf /var/www/html/wishbone/assets'
sh 'rsync -avh --delete src/b3/build/html/ /var/www/html/wishbone/specs/b3'
sh 'rsync -avh --delete src/b3/build/html/ /var/www/html/wishbone/specs/b3.1'
}
}
}
}
37 changes: 1 addition & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,4 @@ Wishbone is an interconnect for Systems-on-Chip.
It's been placed in the public domain and is (as far as we know) free from patents and royalties.
Wishbone is widely used in free and open source designs, but it can also be used in commercial designs without limitations.


Specification Documents
-----------------------

Today, the most used versions of Wishbone are revision B.3, and to a lesser extend, revision B.4.
Revision B.4 most notably adds support for pipelining more efficient access to high-latency peripherals like DRAM.

* [Wishbone B.4](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b4.pdf)
* [Wishbone B.3](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b3.pdf)

Note: Version B.4 adds new features which are not as widely accepted as the functionality of the previous versions.
A future version of the specification will try to reach wider agreement in this regard.

### Superseeded Specifications
The following specification documents have been replaced by newer versions and should not be used for new designs any more.

* [Wishbone B.2](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b2.pdf)
* [Wishbone B.1](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b1.pdf)
* [Wishbone B.0](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b0.pdf)
* [Wishbone A.1](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_a1.pdf)
* [Wishbone A.0](https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_a0.pdf)


Application Notes
-----------------

* [Combining Wishbone interface signals by Richard Herveille](https://github.com/fossi-foundation/wishbone/raw/master/documents/appnotes/appnote_01.pdf)
* [Review of Three SoC Buses by Rudolf Usselmann](https://github.com/fossi-foundation/wishbone/raw/master/documents/soc_bus_comparison.pdf)


Contributing and Maintainership
-------------------------------

The primary author and maintainer of the Wishbone specification is Richard Herveille.
The specification is now maintained by a group of people under the umbrella of the [FOSSi Foundation](https://www.fossi-foundation.org).
Please join the discussion@lists.librecores.org mailing list ([subscribe](https://lists.librecores.org/listinfo/discussion)) if you have questions or want to contribute to the specification process.
Find more information on our website: [https://wishbone-interconnect.org](https://wishbone-interconnect.org)
9 changes: 7 additions & 2 deletions website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ <h5 class="card-header">Stable specifications</h5>
DRAM.

<ul>
<li><a href="https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b3.pdf">Wishbone B.3</a></li>
<li><a href="https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b4.pdf">Wishbone B.4</a></li>
<li>Wishbone B.3 - <a href="/assets/wishbone-b3.pdf">pdf</a> <a href="/specs/b3/">html</a></li>
<li>Wishbone B.4 - <a href="https://github.com/fossi-foundation/wishbone/raw/master/documents/spec/wbspec_b4.pdf">pdf</a></li>
</ul>

Note: Version B.4 adds new features which are not as
Expand Down Expand Up @@ -61,6 +61,11 @@ <h5 class="card-header">Upcoming Specifications and Contributing</h5>
our <a href="https://github.com/fossi-foundation/wishbone">GitHub
repository</a>.

</p>
<p class="card-text">

Find the current state here: <a href="/assets/wishbone-b3-1.pdf">pdf</a> <a href="/specs/b3.1/">html</a>

</p>
<p class="card-text">

Expand Down

0 comments on commit 194a490

Please sign in to comment.