Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 354085 - [documentation] Complement the Git reader type documentation
Summary: [documentation] Complement the Git reader type documentation
Status: NEW
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Buckminster (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: buckminster.core-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 324441 355724
Blocks:
  Show dependency tree
 
Reported: 2011-08-07 06:59 EDT by Thomas Hallgren CLA
Modified: 2019-02-25 14:40 EST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
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.