Talk:Setting up Gerrit: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(complain about git config --global)
 
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
* It is bad form to tell users to make `--global` git configuration changes to conform to the policies of a single project. [[User:Sparr|Sparr]] ([[User talk:Sparr|talk]]) 06:00, 18 December 2018 (UTC)
==global git config?==
It is bad form to tell users to make `--global` git configuration changes to conform to the policies of a single project.
--[[User:Sparr|Sparr]] ([[User talk:Sparr|talk]]) 06:00, 18 December 2018 (UTC)
 
: Firstly, most of the settings are entirely uncontroversial. Some should be just git defaults (some are meanwhile). Secondly, anyone who seriously works on Qt will have 50+ Qt repositories, which easily dwarfs everything else they have on their disk, so the pragmatic choice is to make the Qt settings the global default and override them where necessary.
: --[[User:Ossi|Ossi]] ([[User talk:Ossi|talk]]) 07:47, 12 September 2019 (UTC)
 
 
==doc not clear?==
Under "[[Setting_up_Gerrit#Local_Setup|Local Setup]]", in the last step, it says:
 
> If the connection is functional, every Gerrit event should be displayed
 
But it gives no explanation of "every gerrit event" nor what the output might look like.
 
After I did all the above steps successfully, i issued the last command '''ssh codereview.qt-project.org gerrit stream-events''', and my terminal just sat there, showing no output, doing nothing, and did not return to the command prompt.
 
What is expected here?
--[[User:DHLaw|DHLaw]]
 
:the instructions have been indeed botched up; i haven't been watching closely enough. will fix now.
:--[[User:Ossi|Ossi]] ([[User talk:Ossi|talk]]) 11:12, 8 January 2021 (UTC)
 
==two separate SSH keys?==
 
in the section "How to get started - Gerrit registration", step 5 says "Go to "Settings"-> "SSH Public Keys" and upload your [https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh public SSH Key]". You'll note that the link for "public SSH key" points to github, which instructs the user to create a key named "ed25519". After that we are told to add it into the "gerrit->ssh keys" section. So far so good.
 
But then below, in the next section "Local Setup", we are instructed to create another SSH key named "id_rsa", and also add that into the "gerrit->ssh keys" section. Is this correct?  we are to have two keys with different names?
 
== What is Gerrit and why set it up? ==
 
I came across this page from the [https://doc.qt.io/Boot2Qt-5.15/qtee-meta-qt5.html#using-qt-5-15-lts-commercial-releases Boot2Qt instructions].
What is this page, what is Gerrit, and why do I care?
As it stands, this page is a stand-alone page with no clear explanation for why it even exists.
 
Proposal
* Add an explanation of what Gerrit is
* Add a table of contents that links this step to other related info
* Also add a previous and next page
** Not a perfect example, but [https://doc.qt.io/qtcreator/creator-how-tos.html#analyze this is an example of a guide] that acts like a series of guides
* Add "See also"
 
Example table of contents:
Getting started with contributing to Qt
* Create a Qt account (page link)
* Something (page link)
* Something (page link)
* '''Setting up Gerrit''' (bolded)
* Something (page link)
* Something (page link)
--[[User:Mairtin|Mairtin]] ([[User talk:Mairtin|talk]]) 06:38, 5 December 2023 (UTC)
 
: that link in the documentation is bogus; you never should have come here via this route. presumably, it should point to [[Building_Qt_5_from_Git]]. please file a bug.
: the regular route to this page is via [[Qt_Contribution_Guidelines]].
: --[[User:Ossi|Ossi]] ([[User talk:Ossi|talk]]) 10:33, 5 December 2023 (UTC)
 
:: It may be bogus, but at least for the yocto project I'm working on, setting up your Gerrit account '''is''' a required step.
:: Could probably be handled differently, but for now, a gerrit account + ssh key and CLA agreement + proper group assignments seems to be necessary.
:: --[[User:Mairtin|Mairtin]] ([[User talk:Mairtin|talk]]) 12:08, 5 December 2023 (UTC)
== Move git cloning (etc) to it's own page? ==
 
Is there a reason that the git setup is on this page?
It's not intuitive that someone needs to search the Gerrit page to find instructions on how to configure their git.
 
Side note, is Gerrit only used for Qt 5? Or is this page just outdated and in need of updating with Qt 6? (A likely byproduct of the fact that the cloning instructions are on a page that no one would think to search for)
--[[User:Mairtin|Mairtin]] ([[User talk:Mairtin|talk]]) 06:48, 5 December 2023 (UTC)
 
: the setup is oriented towards developers of qt, who need both git and gerrit, so it makes sense to have this on one page.
: the "qt 5" reference is still valid in the sense that qt 6 also lives in the qt5 repo namespace. this is in contrast to qt 4, which was in a monorepo. it would not hurt to clarify this in various git-related pages.
: --[[User:Ossi|Ossi]] ([[User talk:Ossi|talk]]) 10:33, 5 December 2023 (UTC)
 
:: Hi Ossi, I think it could still be broken into multiple smaller pages.
:: That, or the title could use an update like "Setting up Gerrit and Git for contribution"
:: --[[User:Mairtin|Mairtin]] ([[User talk:Mairtin|talk]]) 12:01, 5 December 2023 (UTC)
 
::: a lot of editorial work could be done on the whole wiki. doesn't seem to be a priority ...
::: renaming a page actually creates a new one and an automatic redirect. that works, but comes with some ugliness, so i wouldn't bother for such a minor thing.
::: --[[User:Ossi|Ossi]] ([[User talk:Ossi|talk]]) 12:27, 5 December 2023 (UTC)

Latest revision as of 12:27, 5 December 2023

global git config?

It is bad form to tell users to make `--global` git configuration changes to conform to the policies of a single project. --Sparr (talk) 06:00, 18 December 2018 (UTC)

Firstly, most of the settings are entirely uncontroversial. Some should be just git defaults (some are meanwhile). Secondly, anyone who seriously works on Qt will have 50+ Qt repositories, which easily dwarfs everything else they have on their disk, so the pragmatic choice is to make the Qt settings the global default and override them where necessary.
--Ossi (talk) 07:47, 12 September 2019 (UTC)


doc not clear?

Under "Local Setup", in the last step, it says:

> If the connection is functional, every Gerrit event should be displayed

But it gives no explanation of "every gerrit event" nor what the output might look like.

After I did all the above steps successfully, i issued the last command ssh codereview.qt-project.org gerrit stream-events, and my terminal just sat there, showing no output, doing nothing, and did not return to the command prompt.

What is expected here? --DHLaw

the instructions have been indeed botched up; i haven't been watching closely enough. will fix now.
--Ossi (talk) 11:12, 8 January 2021 (UTC)

two separate SSH keys?

in the section "How to get started - Gerrit registration", step 5 says "Go to "Settings"-> "SSH Public Keys" and upload your public SSH Key". You'll note that the link for "public SSH key" points to github, which instructs the user to create a key named "ed25519". After that we are told to add it into the "gerrit->ssh keys" section. So far so good.

But then below, in the next section "Local Setup", we are instructed to create another SSH key named "id_rsa", and also add that into the "gerrit->ssh keys" section. Is this correct? we are to have two keys with different names?

What is Gerrit and why set it up?

I came across this page from the Boot2Qt instructions. What is this page, what is Gerrit, and why do I care? As it stands, this page is a stand-alone page with no clear explanation for why it even exists.

Proposal

  • Add an explanation of what Gerrit is
  • Add a table of contents that links this step to other related info
  • Also add a previous and next page
  • Add "See also"

Example table of contents: Getting started with contributing to Qt

  • Create a Qt account (page link)
  • Something (page link)
  • Something (page link)
  • Setting up Gerrit (bolded)
  • Something (page link)
  • Something (page link)

--Mairtin (talk) 06:38, 5 December 2023 (UTC)

that link in the documentation is bogus; you never should have come here via this route. presumably, it should point to Building_Qt_5_from_Git. please file a bug.
the regular route to this page is via Qt_Contribution_Guidelines.
--Ossi (talk) 10:33, 5 December 2023 (UTC)
It may be bogus, but at least for the yocto project I'm working on, setting up your Gerrit account is a required step.
Could probably be handled differently, but for now, a gerrit account + ssh key and CLA agreement + proper group assignments seems to be necessary.
--Mairtin (talk) 12:08, 5 December 2023 (UTC)

Move git cloning (etc) to it's own page?

Is there a reason that the git setup is on this page? It's not intuitive that someone needs to search the Gerrit page to find instructions on how to configure their git.

Side note, is Gerrit only used for Qt 5? Or is this page just outdated and in need of updating with Qt 6? (A likely byproduct of the fact that the cloning instructions are on a page that no one would think to search for) --Mairtin (talk) 06:48, 5 December 2023 (UTC)

the setup is oriented towards developers of qt, who need both git and gerrit, so it makes sense to have this on one page.
the "qt 5" reference is still valid in the sense that qt 6 also lives in the qt5 repo namespace. this is in contrast to qt 4, which was in a monorepo. it would not hurt to clarify this in various git-related pages.
--Ossi (talk) 10:33, 5 December 2023 (UTC)
Hi Ossi, I think it could still be broken into multiple smaller pages.
That, or the title could use an update like "Setting up Gerrit and Git for contribution"
--Mairtin (talk) 12:01, 5 December 2023 (UTC)
a lot of editorial work could be done on the whole wiki. doesn't seem to be a priority ...
renaming a page actually creates a new one and an automatic redirect. that works, but comes with some ugliness, so i wouldn't bother for such a minor thing.
--Ossi (talk) 12:27, 5 December 2023 (UTC)