unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
* [bug#65152] [PATCH] services: Modify cgit-configuration fields
@ 2023-08-08 16:37 Thomas Albers via Guix-patches via
  2023-08-21 17:22 ` Ludovic Courtès
  0 siblings, 1 reply; 4+ messages in thread
From: Thomas Albers via Guix-patches via @ 2023-08-08 16:37 UTC (permalink / raw)
  To: 65152; +Cc: Thomas Albers

* 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





^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [bug#65152] [PATCH] services: Modify cgit-configuration fields
  2023-08-08 16:37 [bug#65152] [PATCH] services: Modify cgit-configuration fields Thomas Albers via Guix-patches via
@ 2023-08-21 17:22 ` Ludovic Courtès
  2023-08-22  9:18   ` Thomas Albers Raviola via Guix-patches via
  0 siblings, 1 reply; 4+ messages in thread
From: Ludovic Courtès @ 2023-08-21 17:22 UTC (permalink / raw)
  To: Thomas Albers; +Cc: 65152

Hi,

Thomas Albers <thomas@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’.




^ permalink raw reply	[flat|nested] 4+ messages in thread

* [bug#65152] [PATCH] services: Modify cgit-configuration fields
  2023-08-21 17:22 ` Ludovic Courtès
@ 2023-08-22  9:18   ` Thomas Albers Raviola via Guix-patches via
  2023-09-09 10:32     ` bug#65152: " Ludovic Courtès
  0 siblings, 1 reply; 4+ messages in thread
From: Thomas Albers Raviola via Guix-patches via @ 2023-08-22  9:18 UTC (permalink / raw)
  To: Ludovic Courtès; +Cc: 65152

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




^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#65152: [PATCH] services: Modify cgit-configuration fields
  2023-08-22  9:18   ` Thomas Albers Raviola via Guix-patches via
@ 2023-09-09 10:32     ` Ludovic Courtès
  0 siblings, 0 replies; 4+ messages in thread
From: Ludovic Courtès @ 2023-09-09 10:32 UTC (permalink / raw)
  To: Thomas Albers Raviola; +Cc: 65152-done

Hi,

Thomas Albers Raviola <thomas@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’.




^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2023-09-09 10:33 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-08 16:37 [bug#65152] [PATCH] services: Modify cgit-configuration fields Thomas Albers via Guix-patches via
2023-08-21 17:22 ` Ludovic Courtès
2023-08-22  9:18   ` Thomas Albers Raviola via Guix-patches via
2023-09-09 10:32     ` bug#65152: " Ludovic Courtès

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).