Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align documentation to migrated repository. #3

Merged
merged 2 commits into from
Jun 26, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified images/base-branch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/head-branch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/old-fork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/pull-request-gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/pull-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/topic-collector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,17 @@ you forgot to register your ssh key when you registered to github, you can do
it by going to <https://github.com/settings/ssh> and adding your public key
there.

### My repository and the official CMSSW repository seem to be completely different!

This probably means that you did not reset your fork on the 26th of June, when
the git migration started. All the copies of the repository before that are to
be considered obsolete.

You can check you have the correct fork by looking at your repository page,
`https://github.com/<username>/cmssw`, if it shows that you have forked from the
repository called `cms-sw/cmssw-old` it means that you need to fork again.

![old-fork](old-fork.png)

You can fix this by deleting your current fork (look under the settings
directory), and then fork again.
28 changes: 14 additions & 14 deletions tutorial.mdwn
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ questions please have a look at the [FAQ](faq.html) pages.

> Set up the work area just like you used to.

> scram project CMSSW_6_2_0_pre7
> cd CMSSW_6_2_0_pre7/src
> scram project CMSSW_6_2_0_pre8
> cd CMSSW_6_2_0_pre8/src
> cmsenv

### Checkout a few packages using git cms-addpkg
Expand All @@ -27,17 +27,16 @@ questions please have a look at the [FAQ](faq.html) pages.
The src directory is populated with just what we asked for (here
`Tutorial/Test`).

> git cms-addpkg Tutorial/Test CMSSW_6_2_0_TUTORIAL
> git cms-addpkg Tutorial/Test
> ls Tutorial/Test/bin
BuildFile.xml

>Notice we had to provide the `CMSSW_6_2_0_TUTORIAL` tag explicitly because
>there is no real release called like that. By default it would simply use the
>current release name (e.g. CMSSW_6_2_0_pre7). At any point you can list the
> available branches via `git branch`.
>By default it would simply use the current release tag (e.g.
>CMSSW_6_2_0_pre8). At any point you can list the available branches via `git
>branch`.

> git branch
* from-CMSSW_6_2_0_TUTORIAL
* from-CMSSW_6_2_0_pre8

> the `*` next to the branch name will tell you which one is the current one.
> The name of the branch is meant to show you the tag which was used as a base
Expand All @@ -64,7 +63,7 @@ The src directory is populated with just what we asked for (here
> cd Tutorial/Test
> nedit bin/BuildFile.xml
> git commit -m "Test feature" bin/BuildFile.xml
[my-new-feature dc306ba] Test feature
[my-new-feature 8135042] Test feature
1 file changed, 1 insertion(+)

> You have just committed to your **LOCAL** copy of the repository.
Expand All @@ -79,8 +78,8 @@ The src directory is populated with just what we asked for (here
>To show what remotes are available you can use `git remote show`:

> git remote show
official-cmssw
my-cmssw
official-cmssw

>The general workflow for development will be the following:
>- Fetch official sources from `official-cmssw`.
Expand Down Expand Up @@ -128,16 +127,17 @@ The src directory is populated with just what we asked for (here

![Pull request](images/pull-request-gui.png)

> First of all, select the "head branch" i.e. your addition on to of the official CMSSW.
> If you click on the "Edit" button in the top right corner, you can select the
> "head branch" i.e. your addition on to of the official CMSSW.

![Pull request](images/head-branch.png)

> Then select the "base branch", i.e. the one to which you want to have your changes merged.
> Or change the "base branch", i.e. the one to which you want to have your changes merged.

![Pull requests GUI](images/base-branch.png)

> *write a sensible comment* just like you used to do for the publishing of
> tagsets and click on Send Pull Request.
> Remember to *write a sensible comment* just like you used to do for the
> publishing of tagsets and click on Send Pull Request.

### Go to the Topic Collector and check approval status

Expand Down