diff mbox series

[bug#51509] doc: Mention Hg support for 'guix import cran' and some caveats.

Message ID 0ef4d3530562037b77f17ef5a672d2baee7b5970.1635591629.git.public@yoctocell.xyz
State New
Headers show
Series [bug#51509] doc: Mention Hg support for 'guix import cran' and some caveats. | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch success View Laminar job
cbaines/issue success View issue

Commit Message

Xinglu Chen Oct. 30, 2021, 11:03 a.m. UTC
* guix.texi (Invoking guix import): Mention support for Mercurial repositories
  for the CRAN importer, and some caveats with the Git and Mercurial backends.
---
Prompted by Ricardo’s comments on the “Accuracy of importers” thread:

<https://yhetil.org/guix-devel/87mtmq7pes.fsf@disroot.org/T/#mabff98d436895c18f177c4016792ec215f645bbf>

 doc/guix.texi | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)


base-commit: cd188b9c6f28bd907b625a5cd6c616d1d2529671

Comments

Ricardo Wurmus Nov. 27, 2021, 9:17 a.m. UTC | #1
Hi,

> * guix.texi (Invoking guix import): Mention support for 
> Mercurial repositories
>   for the CRAN importer, and some caveats with the Git and 
>   Mercurial backends.
> ---
> Prompted by Ricardo’s comments on the “Accuracy of importers” 
> thread:
>
> <https://yhetil.org/guix-devel/87mtmq7pes.fsf@disroot.org/T/#mabff98d436895c18f177c4016792ec215f645bbf>

I’d prefer not to mention the limitation (as it’s an 
rstudio-specific modification to DESCRIPTION files) and instead 
work on supporting this extension to the DESCRIPTION file.  I 
already have some WIP to address this.
Xinglu Chen Dec. 19, 2021, 9:04 a.m. UTC | #2
Hi,

On Sat, Nov 27 2021, Ricardo Wurmus wrote:

> Hi,
>
>> * guix.texi (Invoking guix import): Mention support for 
>> Mercurial repositories
>>   for the CRAN importer, and some caveats with the Git and 
>>   Mercurial backends.
>> ---
>> Prompted by Ricardo’s comments on the “Accuracy of importers” 
>> thread:
>>
>> <https://yhetil.org/guix-devel/87mtmq7pes.fsf@disroot.org/T/#mabff98d436895c18f177c4016792ec215f645bbf>
>
> I’d prefer not to mention the limitation (as it’s an 
> rstudio-specific modification to DESCRIPTION files) and instead 
> work on supporting this extension to the DESCRIPTION file.  I 
> already have some WIP to address this.

Just to clarify, you are referring to the fact that the ‘--recursive’
option won’t work, not the fact that the ‘hg’ binary needs to be in
$PATH, right?  In that case I will send a new reroll removing the
following sentence:

--8<---------------cut here---------------start------------->8---
+One limitation of this is that dependencies that are also hosted on Git
+or Mercurial repositories cannot be imported.
--8<---------------cut here---------------end--------------->8---
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 22215214e0..661e29e69c 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -11852,14 +11852,20 @@ 
 guix import cran --archive=bioconductor GenomicRanges
 @end example
 
-Finally, you can also import R packages that have not yet been published on
-CRAN or Bioconductor as long as they are in a git repository.  Use
-@option{--archive=git} followed by the URL of the git repository:
+Finally, you can also import R packages that have not yet been published
+on CRAN or Bioconductor as long as they are in a Git or Mercurial
+repository.  Use @option{--archive=git} or @option{--archive=hg}
+followed by the URL of the repository:
 
 @example
 guix import cran --archive=git https://github.com/immunogenomics/harmony
 @end example
 
+One limitation of this is that dependencies that are also hosted on Git
+or Mercurial repositories cannot be imported.  Also, note that the
+@command{hg} executable has to be in the users's @env{PATH} for the
+Mercurial backend to work.
+
 @item texlive
 @cindex TeX Live
 @cindex CTAN