[llvm-commits] [PATCH 2/3] docs/GettingStarted.html: [Git] Mention branch.master.rebase for the tracking branch.

[Jeffrey Yasskin]

> diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html
> index 5e1985e..804a384 100644
> --- a/docs/GettingStarted.html
> +++ b/docs/GettingStarted.html
> @@ -814,6 +814,15 @@ cd llvm/tools
>  git clone http://llvm.org/git/clang.git
>  </pre>
>
> +<p>
> +It would be good to set the tracking branch <tt>master</tt> rebased to
> +<tt>origin/master</tt>, since the upstream is hosted by Subversion.

Perhaps reword to:

"Since the upstream repository is in Subversion, you should use `git
pull --rebase` instead of `git pull` to avoid generating a non-linear
history in your clone. To configure `git pull` to pass --rebase by
default on the master branch, run the following command:"

I'm nervous about suggesting to newbies that they make --rebase
implicit. This will cause problems if people develop on their master
branch and then try to share it, and without seeing --rebase on each
pull line, they may not remember what's causing the trouble. Maybe it
makes sense to move this into the git-svn section, and phrase it more
as "if you want to make the --rebase implicit on pulls into the master
branch, use the following config command"?

Of course, I'm far from an expert in this, so if this is something
everyone does for tracking branches of git-svn repositories, I won't
argue.

> +</p>
> +
> +<pre class="doc_code">
> +git config branch.master.rebase true
> +</pre>
> +
>  <h4>For developers to work with git-svn</h4>
>  <div>


On Sat, Jul 23, 2011 at 9:30 PM, NAKAMURA Takumi <geek4civic at gmail.com> wrote:
> ---
>  docs/GettingStarted.html |    9 +++++++++
>  1 files changed, 9 insertions(+), 0 deletions(-)