Outdated instructions in "git the hard way"

[Nils Bruin]

On:

https://doc.sagemath.org/html/en/developer/manual_git.html

it is suggested to start with

git clone https://gitlab.com/sagemath/dev/tracmirror.git

however, the gitlab mirror is stuck at 9.3. The github mirror tracks the development tree much better. Shouldn't we be pointing people to that instead? Or perhaps straight to trac.sagemath.org ?

Incidentally, on FC 33 and FC 34, the default settings are pretty strict for cryptographic signatures, and "ssh g...@trac.sagemath.org info" fails as a result.  A way of making FC >=33 more accepting of outdated signature schemes is by:

sudo update-crypto-policies --set LEGACY

[John H Palmieri]

Could you please open a ticket for this?

[Jean-Florent Raymond]

There are other problems in the documentation related to building from
source, which could be added to this ticket. I noticed them as I
recently tried to build from source from scratch.

The suggested commands on the page you mentioned are:

[user@localhost ~]$ git clone https://gitlab.com/sagemath/dev/tracmirror.git
[user@localhost ~]$ cd sage
[user@localhost sage]$ git checkout develop
[user@localhost sage]$ make

The second line fails because the folder is called `tracmirror` and not
`sage`.
When I run `make` as instructed I get the error "Sage source tree is
unconfigured. Please run "./configure" first." However just after
cloning there is no 'configure' file in the folder.
Note that the same problem arises with instructions at
https://doc.sagemath.org/html/en/developer/walk_through.html#obtaining-the-sage-source-code
Also, the page
https://doc.sagemath.org/html/en/installation/source.html#general-procedure
instructs to run `configure` right after cloning, which fails because
the file does not exits.

According to the main readme (
https://github.com/sagemath/sage#instructions-to-build-from-source ) it
seems that the correct way to build sage from source from scratch is to
first run `make configure` (step 5). By the way steps 5 and 4 could be
switched in this file, as step 4 refers to the file `configure` that
does not exist before step 5.

Shouldn't we keep a single page with up-to-date instructions instead of
multiple duplicates that are hard to maintain?

[Dima Pasechnik]

Well, we need to monitor gitlab better. I'm trying to fix the mirroring now.

Dima

> --
> You received this message because you are subscribed to the Google Groups "sage-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/b35e6888-ab4b-4d20-bb32-14c8ffec7042n%40googlegroups.com.

[Dima Pasechnik]

Unfortunately, I am stuck trying to fix this. It's not clear how to
set up the authentication.
Gitlab isn't the best documented thing out there.

Indeed, let us switch to github in our docs.
We'd perhaps move building Sage's docker containers to github, too.

Dima

[Matthias Koeppe]

https://trac.sagemath.org/ticket/29784 can be used for this

[Eric Gourgoulhon]

Also the title of that section, "Git the hard way", should be changed. It should rather be "Git the *standard* way" IMHO.

Eric.

[Vincent Delecroix]

+1 : Learning git is a useful skill. And a developer is likely to
know git already.

[Dima Pasechnik]

I think that 'git trac' is mainly used by the release manager - I
won't recommend it to newcomers.


On Thu, Sep 9, 2021 at 9:36 AM Vincent Delecroix

> --
> You received this message because you are subscribed to the Google Groups "sage-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.

> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/510102cf-26fc-f834-4d6c-d5865a1e5b8b%40gmail.com.

[Martin R]

Actually, I use "git trac" a lot.  Mainly "git trac try", "git trac pull" and "git trac create".  I find it very convenient to only pass the trac ticket number.

Martin

[Thierry]

Hi,

On Thu, Sep 09, 2021 at 03:04:37AM -0700, 'Martin R' via sage-devel wrote:
> Actually, I use "git trac" a lot. Mainly "git trac try", "git trac pull"
> and "git trac create". I find it very convenient to only pass the trac
> ticket number.

I use it a lot too. Let me also mention "git trac find" which, combined to
"git blame" allows you to discover which ticket introduced some feature or
bug, then you can add the participants in CC of a ticket corresponding to
that feature or bug.

Ciao,
Thierry

> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/4eb2c412-2234-495f-a4b9-0e552a968eebn%40googlegroups.com.

[Matthias Koeppe]

I use git-trac all the time, but I do agree that it is better for the developer's manual to begin with standard git instructions and only describe git-trac as an optional convenience tool. 

We should avoid the impression that project-specific special tooling is required if people want to contribute to the project.

Matthias

[Dima Pasechnik]

On Thu, Sep 9, 2021 at 4:00 PM Matthias Koeppe <matthia...@gmail.com> wrote:
>
> I use git-trac all the time, but I do agree that it is better for the developer's manual to begin with standard git instructions and only describe git-trac as an optional convenience tool.
> We should avoid the impression that project-specific special tooling is required if people want to contribute to the project.

Indeed. Also, we regularly get messages asking for help with "git
trac", and the only way is usually to use "normal" git to fix these.

Also a brief explanation of that "git trac" magic does in terms of
plain git should be helpful.

Dima

> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/2817e314-bea1-47c0-8814-0d7f6f26b86en%40googlegroups.com.

[kcrisman]

Also a brief explanation of that "git trac" magic does in terms of
plain git should be helpful.

That is a very good point that might lead people starting with git trac to use "standard" git. 

[Simon King]

Hi Dima,

On 2021-09-09, Dima Pasechnik <dim...@gmail.com> wrote:
> I think that 'git trac' is mainly used by the release manager - I
> won't recommend it to newcomers.

No, I'm not a release manager, but I find it very practical to be able
to do "git trac pull 12345" instead of doing a series of commands that
I simply don't manage to memorise.

Best regards,
Simon

[Dima Pasechnik]

assuming that "trac" points to our Git server (as it normally done) this is just

git pull trac <name of the ticket branch>

Best regards,
Simon

--
You received this message because you are subscribed to the Google Groups "sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/shg8p9%2445p%241%40ciao.gmane.io.

[Thierry]

Hi,

On Mon, Sep 13, 2021 at 02:05:36PM +0100, Dima Pasechnik wrote:
> On Fri, 10 Sep 2021, 19:39 Simon King, <simon...@uni-jena.de> wrote:
>
> > Hi Dima,
> >
> > On 2021-09-09, Dima Pasechnik <dim...@gmail.com> wrote:
> > > I think that 'git trac' is mainly used by the release manager - I
> > > won't recommend it to newcomers.
> >
> > No, I'm not a release manager, but I find it very practical to be able
> > to do "git trac pull 12345" instead of doing a series of commands that
> > I simply don't manage to memorise.
> >
>
> assuming that "trac" points to our Git server (as it normally done) this is
> just
>
> git pull trac <name of the ticket branch>

This is not "just": your suggestion hides the fact that you have to
copy/paste the name of the ticket branch from a webbrowser, which is
boring and takes time.

The point of the "git trac" command is to link git branches with trac
tickets, so that you do not have to do it by hand.

Ciao,
Thierry

>
> > Best regards,
> > Simon
> >
> > --
> > You received this message because you are subscribed to the Google Groups
> > "sage-devel" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to sage-devel+...@googlegroups.com.
> > To view this discussion on the web visit
> > https://groups.google.com/d/msgid/sage-devel/shg8p9%2445p%241%40ciao.gmane.io
> > .
> >
>
> --
> You received this message because you are subscribed to the Google Groups "sage-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.

> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/CAAWYfq3%3Dk9aMWaXPv%2BpGrXtq0rv3VWFESKa5YswnhVvK_3gL2g%40mail.gmail.com.

[Dima Pasechnik]

On Mon, 13 Sep 2021, 14:35 Thierry, <sage-goo...@lma.metelu.net> wrote:

Hi,

On Mon, Sep 13, 2021 at 02:05:36PM +0100, Dima Pasechnik wrote:
> On Fri, 10 Sep 2021, 19:39 Simon King, <simon...@uni-jena.de> wrote:
>
> > Hi Dima,
> >
> > On 2021-09-09, Dima Pasechnik <dim...@gmail.com> wrote:
> > > I think that 'git trac' is mainly used by the release manager - I
> > > won't recommend it to newcomers.
> >
> > No, I'm not a release manager, but I find it very practical to be able
> > to do "git trac pull 12345" instead of doing a series of commands that
> > I simply don't manage to memorise.
> >
>
> assuming that "trac" points to our Git server (as it normally done) this is
> just
>
> git pull trac <name of the ticket branch>


This is not "just": your suggestion hides the fact that you have to
copy/paste the name of the ticket branch from a webbrowser, which is
boring and takes time.

The point of the "git trac" command is to link git branches with trac
tickets, so that you do not have to do it by hand.

I was mainly saying it's not a series of commands, but one command.

As well, if this branch name is already in your git tree, you can use tab completion to type it quickly in.

Ciao,
Thierry




>
> > Best regards,
> > Simon
> >
> > --
> > You received this message because you are subscribed to the Google Groups
> > "sage-devel" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to sage-devel+...@googlegroups.com.
> > To view this discussion on the web visit
> > https://groups.google.com/d/msgid/sage-devel/shg8p9%2445p%241%40ciao.gmane.io
> > .
> >
>
> --
> You received this message because you are subscribed to the Google Groups "sage-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/CAAWYfq3%3Dk9aMWaXPv%2BpGrXtq0rv3VWFESKa5YswnhVvK_3gL2g%40mail.gmail.com.

--
You received this message because you are subscribed to the Google Groups "sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/20210913133536.GA17667%40metelu.net.

[Matthias Koeppe]

OK who's going to push the first commit to the ticket https://trac.sagemath.org/ticket/29784 ?

[Matthias Koeppe]

I have made some of the suggested changes in https://trac.sagemath.org/ticket/29784, needs review.