Skip to content

Development process

Martin Barnasconi edited this page Oct 18, 2021 · 3 revisions

Development Process

  • fork the upstream code repository to your GitHub account (Fork button on GitHub webpage)

  • clone the repository to your local machine:

    $ git clone https://github.com/<youraccount>/uvm-systemc.git

  • create a new branch for the development of each feature or bug fix, which is forked and checked out from the master branch. It is recommended to use a branch name including your company name and name of the feature

    $ git checkout -b <company>-<feature-xyz> master

  • make changes to your local repo and commit the changes

    $ git commit -m "description of edits"

  • push your changes in the used branch to your own GitHub repository (origin, not upstream)

    $ git push origin <company>-<feature-xyz>

  • Open a pull request on the upstream code repository with the proposed changes made in your branch (GitHub webpage)

Building and running UVM-SystemC on your local machine

The uvm-systemc development tree does not contain the generated configure executable to build the library using the automake flow (i.e. configure, make, make install). Instead, as developer, you should bootstrap the library first.

After cloning the library to your local machine (see procedure above), execute the following commands:

  $ cd uvm-systemc
  $ config/bootstrap 

This will create the configure executable in the uvm-systemc directory. After this, follow the procedure as defined in the INSTALL file, section Basic UVM-SystemC Installation

More information

More information on the development process can be found in https://github.com/OSCI-WG/systemc/blob/master/docs/DEVELOPMENT.md

Clone this wiki locally