Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 354085

Summary: [documentation] Complement the Git reader type documentation
Product: z_Archived Reporter: Thomas Hallgren <thomas>
Component: BuckminsterAssignee: buckminster.core-inbox <buckminster.core-inbox>
Status: NEW --- QA Contact:
Severity: normal    
Priority: P3    
Version: unspecified   
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:
Bug Depends on: 324441, 355724    
Bug Blocks:    

Description Thomas Hallgren CLA 2011-08-07 06:59:48 EDT
Here is some additional information (originally from bug 324441) that should be added to the documentation for the git reader type:

1. Checking out a tag will normally create a detached head. Buckminster will
therefore automatically create a branch with the name 'tag-branch_' + tagName
when this happens.

2. Checking out remote branches is considered very bad practice (it also
results in a detached head). Buckminster will therefore create a local branch
with the same name as the remote and track the remote branch. This is
essentially the same as git checkout --track -b <branch> origin/<branch>

3. branches like remotes/origin/<branchName> or origin/<branchName> will
automatically be stripped down to just <branchName> to avoid checkouts of the
remote branch. In essence, such name should not be used, but if they are,
Buckminster "fixes" that.
Comment 1 Thomas Hallgren CLA 2011-08-25 03:39:47 EDT
The Git reader type will now refrain from switching to the "master" branch when no branch/tag advice is given in the CQUERY. See bug 355724. I guess that too deserves a mention in the documentation.