GNU bug report logs - #65152
[PATCH] services: Modify cgit-configuration fields

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 65152 in the body.
You can then email your comments to 65152 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Thomas Albers <thomas <at> thomaslabs.org>
To: guix-patches <at> gnu.org
Cc: Thomas Albers <thomas <at> thomaslabs.org>
Subject: [PATCH] services: Modify cgit-configuration fields
Date: Tue,  8 Aug 2023 18:37:10 +0200

* gnu/services/cgit.scm (cgit-configuration)[root-readme]: Accept
'file-object' instead of only 'string'
---
 gnu/services/cgit.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index e33cb9e7db..684ab73f76 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -581,7 +581,7 @@ (define-configuration cgit-configuration
    (string "a fast webinterface for the git dscm")
    "Text printed below the heading on the repository index page.")
   (root-readme
-   (string "")
+   (file-object "")
    "The content of the file specified with this option will be included
 verbatim below the \"about\" link on the repository index page.")
   (root-title
-- 
2.41.0

Message #8 received at 65152 <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Thomas Albers <thomas <at> thomaslabs.org>
Cc: 65152 <at> debbugs.gnu.org
Subject: Re: bug#65152: [PATCH] services: Modify cgit-configuration fields
Date: Mon, 21 Aug 2023 19:22:18 +0200

Hi,

Thomas Albers <thomas <at> thomaslabs.org> skribis:

> * gnu/services/cgit.scm (cgit-configuration)[root-readme]: Accept
> 'file-object' instead of only 'string'

[...]

>    (root-readme
> -   (string "")
> +   (file-object "")
>     "The content of the file specified with this option will be included
>  verbatim below the \"about\" link on the repository index page.")

I think it’s a good idea but (1) we should preserve backward
compatibility for users passing a string (file contents), and (2) update
the docstrings and its copy in the manual.

Could you send a second version to address these?  Let me know if
anything’s unclear.

Thanks,
Ludo’.

Message #11 received at 65152 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Albers Raviola <thomas <at> thomaslabs.org>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 65152 <at> debbugs.gnu.org
Subject: Re: bug#65152: [PATCH] services: Modify cgit-configuration fields
Date: Tue, 22 Aug 2023 11:18:37 +0200

Hi,

in this context `file-object' is defined to be either a `file-like'
object or a `string'. As such this wouldn't break backward compatibility
but include a superset of possible values.

Also the original string is not used as the contents of the readme file
but as a file path.

However if you still think something should be changed I can send a
second patch addressing any further issues.

Greetings,
Thomas

Message #16 received at 65152-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Thomas Albers Raviola <thomas <at> thomaslabs.org>
Cc: 65152-done <at> debbugs.gnu.org
Subject: Re: bug#65152: [PATCH] services: Modify cgit-configuration fields
Date: Sat, 09 Sep 2023 12:32:13 +0200

Hi,

Thomas Albers Raviola <thomas <at> thomaslabs.org> skribis:

> in this context `file-object' is defined to be either a `file-like'
> object or a `string'. As such this wouldn't break backward compatibility
> but include a superset of possible values.
>
> Also the original string is not used as the contents of the readme file
> but as a file path.

Oh right, my bad, I had misunderstood that.  So it’s all good, applied!

Eventually we should probably replace ‘file-object’ by ‘file-like’,
unless there’s a clear use case for passing out-of-band file names (a
use case would be passwords, but probably not ‘README’ files).

Thanks!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.