Opened 2 years ago

Closed 2 years ago

#23630 closed enhancement (fixed)

Clarify README.HACKING

Reported by: tom Owned by: tbb-team
Priority: Medium Milestone:
Component: Applications/Tor Browser Version:
Severity: Normal Keywords: tbb-rbm, TorBrowserTeam201709R
Cc: boklm Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

As an alternative, if you have your patch in a git repository, you can
edit projects/firefox/config to change the git_url option to point to
your git repository, and change the git_hash option to point to the
commit you want to build. You will also need to comment the
'tag_gpg_id: 1' line (unless git_hash is pointing to a signed git tag).

I presume the current value of git_hash is a tag (and not a branch) right? It'd be good to explain that.

Even better would be if we could build off branches. I guess my ideal situaiton would be:

As an alternative, if you have your patch in a git repository, you can
edit projects/firefox/config to change the git_url option to point to
your git repository.

You can specify git_hash to build off a commit hash or tag, OR
git_branch to build off a branch. (If both are specified, it is an
error.) git_branch may be 'remotename/branchname' in which case the
remote branch is git fetch-ed and then built; or 'branchname' in
which case the local branch is git checkout-ed and then built.

Child Tickets

Change History (4)

comment:1 Changed 2 years ago by gk

Keywords: tbb-rbm added

comment:2 Changed 2 years ago by boklm

The value of git_hash has to be a tag if tag_gpg_id is set to 1. Otherwise it can be anything that is understood by git, including a branch. If you specify a branch, you don't need to specify a remotename, as all branches from the git_url are created as local branches (with git fetch origin +refs/heads/*:refs/heads/*). So it is not a good idea to create local branches in git_clones/* as they can be removed if the remote repository has a branch with the same name. If you want to use local branches, it is better to create them in a separate repository, and change git_url to file:///path to point to your repository.

comment:3 Changed 2 years ago by boklm

Keywords: TorBrowserTeam201709R added
Status: newneeds_review

comment:4 Changed 2 years ago by gk

Resolution: fixed
Status: needs_reviewclosed

Thanks, looks good and applied to master (commit 43e5d8803933af80e6e71005a5f64338c91680d7).

Note: See TracTickets for help on using tickets.