Broken source links in the docs about ex_doc

[josevalim]

Can we ask Git if we are inside a current tag? It would be nice if we could get this automatically but we'd need command line options too. :)

[alco]

What do you mean? Tag just points to a commit. Do you want to automatically find out whether the current commit is tagged? Not sure if that'll help.

The use case for most projects would be to specify the url pattern that includes a specific tag/branch. BTW, we could make it easier for users like we do currently with :github in url patterns (it only supports master now IIRC).

For Elixir, do you manually generate the docs by checking out a specific commit? Then you could do:

λ git checkout v0.8.2
# ...

λ git describe --all `git rev-parse HEAD`
tags/v0.8.2

λ git describe --tags `git rev-parse HEAD`
v0.8.2

λ git checkout master
# ...

λ git describe --tags `git rev-parse HEAD`
v0.8.2-95-ga0787fb

λ git describe --all `git rev-parse HEAD` 
heads/master

[josevalim]

λ git describe --tags `git rev-parse HEAD`
tags/v0.8.2

This is exactly what I had in mind. Get the current commit and check: is it in a tag? If so, use the tag, if not, use the commit hash itself. What do you think?

[alco]

To be clear, git describe --all <hash> could output multiple lines, if the commit hash is pointed to by multiple refs.

Get the current commit and check: is it in a tag?

Hm, I don't think it's our decision to make. Technically, only commit hash will provide 100% reliability in the presence of changes. But the commit itself may become orphan after a force push.

I think the user has to decide. We can provide a shortcut for generating source links based on the current/commit tag in the config options (similar to current :github). But there has to be a config option for this the that user sets explicitly.

[josevalim]

@alco is this fixed after you added the ability to specify a commit/branch/tag or not yet?

[alco]

Both master and stable point to v0.9.2. I thought master should point to a specific commit which was master at the time of doc generation.

[josevalim]

This is because I haven't generating anything from master after v0.9.2. :) I just generated it now and everything worked like a charm, thanks @alco!