Git repository is available

Dear Contributors,

We are pleased to announce availability of the official OCCT Git repository, which should be used since now for submission of the contributions (instead of patches). Please find the information on how to get access to the repository on the Resources page.

For the developers new to Git (including most of our own developers), we have prepared a Guide to installing and using Git for OCCT development. Please read sections 1 and 3 even if you are experienced Git user.

Please have also a look at the updated version of the Contribution Workflow document where additional details related to Git have been added in sections 2.4 and 2.7.

The changes integrated to master branch are shown at the bottom of the relevant issues in the Mantis issue tracker.

Note that OCCT repository contains bare sources of OCCT, and does not contain header and source files generated from CDL (located in subdirectories inc and drv). Thus you will need to generate these files using WOK. For Windows users, we have prepared a binary WOK distribution which we hope should be easy to install and use. Please find it, along with short guide how to build OCCT on Windows with WOK, on the Resources page. Preparation of the binary distribution of WOK on Linux is under way...

As always, we will appreciate any your comment and remarks on the subject.
Please feel free to post your comments either in this or in new threads.

Andrey

Pawel's picture

Hello Andrey,

thanks again for your efforts and for all the clarifications.

I read the updated contribution workflow and have two questions at the moment:

1. Section 2.4 state:

"The issue for which solution is provided should be switched to RESOLVED state and assigned to the developer who is expected to make a code review (Reviewer; by default, can be set to Maintainer of the component)."

As external developer how do I know who is the Maintainer of the corresponding component?
Maybe the maintainer could be suggested automatically by Mantis when selecting the bug category?

2. As I understand section 3.2.2 refers to the PDF documentation, doesn't it? If so how to update that?

Thank you,
Pawel

Andrey BETENEV's picture

Hello Pawel,

Thanks for posting your comment!

1. You are right, the selection of reviewer is not well-defined. For the moment, let's agree to assign Resolved issues to bugmaster.

I suggest you register a record in Mantis for this issue (use category Website:Tracker), and we will try to address it. I believe we can provide either automatic assignment or at least a list of maintainers.

2. The User Guides are maintained currently in Word / PDF format, and developers do not usually edit them directly. In practice, it is sufficient that you provide a message in the 'Documentation updates' field of Mantis issue indicating that some User's Guide should be updated, and how. The update is done by our documentation engineers.

We have an idea to move to using Doxygen for User Guides instead of Word; this would allow integrating documentation with OCCT sources, so that every developer could modify it directly. I hope we will include this in our plans soon.

Andrey

Andrey BETENEV's picture

Please note that we have corrected the guide to clarify that on Windows you normally need to install "Git for Windows" product and not "MSysGit" (which is development environment for Git for Windows). See the new version of the guide, section 2.1. Thanks to the people who spotted the inconsistency!

Pawel's picture

Hello Andrey,

I tried to practice the contribution workflow and met some problems again ;)

I registered an issue, made a local branch, made the correction and committed it locally. When I try to push the branch to the remote repository I get the following error (replace my_email@domain.com with my e-mail address):

git.exe push --progress "origin" CR23097:CR23097

W access for occt DENIED to my_email@domain.com_38
fatal: The remote end hung up unexpectedly

git did not exit cleanly (exit code 128)

I'm not a git expert but it looks like I don't have the write access for the repository. Could that be the problem or maybe I'm doing something wrong?

Please advise.
Thank you!
Pawel

admin's picture

Hello Pavel,

I made correction in configuration scripts of gitolite.
Now you can push you branch to origin.
Please confirm.

Admin

Pawel's picture

Problem solved.
Thank you!

admin's picture

Dear Contributors,

We prepared Linux and Mac OS X binary WOK distributions in addition for Windows one. Distributions are available on the Resources page, Downloads section.
Besides document Building OCCT with WOK was updated for Linux platform.
Notice that though Mac OS X version is published (requires Mac OS X 10.6+ "Snow Leopard" within x86_64 processor and Xcode 3.2.6+) it is not officially supported in any way.

Admin