...
Step-by-step guide
NOTE: it is implied that you already have keys registered with putty. If this is not the case, follow this section, else jump to the "Download" part.NOTE: it is also implied that you already have a gerrit profile setup and you can connect to it.
Preliminary Step: Install Putty and Generate a Putty Key
NOTE: if you already have keys registered with putty, skip this section.
- First, ensure you have the complete putty suite installed. You should have pageant.exe, plink.exe and puttygen.exe
- generate Generate a key with puttygen. Choose a passphrase, then select "Save private key" and choose a target; also "Save public key" and select a target. It is recommended to use file names containing "private" and "public" for the keys as both will end in .ppk
- start Start pageant if not started, then add your newly generated private key
- under Under the control panel > system > advanced system properties > environment variables, add a GIT_SSH entry (if not present) and point to plink.exe
- when When done, start a command line (cmd.exe) and run 'env'; the newly added environment variable should appear
- in In your gerrit profile, add the public key. Also, copy/paste the known_hosts entries listed, into a file named known_hosts under your .ssh profile (something like C:\Users\<ATTUID>\.ssh) (if known_hosts does not exist, create it)
Remaining Steps
Download Python, based on the TSS approved version (2.7.10 at the time of writing):
...
You You MUST select Add python.exe to Path
...
- git config --global --add gitreview.username "your_LF_user_name"
- also, ensure your user.name and user.email are matching for LF (user.name should equal gitreview.username and email should match the email setup for LF)
----- <<TODO: Should we make the section above a sub section ? ----->>
You also need to setup your git user email address to the one defined in your LF account, the easiest way to do so is to run :
...
Note: while entering proxy username, sometimes it may require to add the domain name in front of the username.
SSH or HTTPS
Once Git/Gerrit is installed, you will need to select a connection method to the remote server.
...
Regenerating a password will most likely solve the connectivity issue. Sometime, the gerrit interface on HTTPS might be temporarily faulty, so retries might be needed.
Cloning
...
the Repository Using the Command Line
Add a remote pointer to the Gerrit server hosting your repository (behind the company VPN Windows users will use the alternate command)
...
IntelliJ gerrit plugin setup could be found <HERE>
...
<<TODO: Should we make the below section a sub section
...
?>>
Linux Foundation uses Gerrit to download and upload code into repository. Gerrit plugin could be downloaded and installed in IntelliJ, in order to work with the LF code downloading/uploading procedure.
...