Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.maint.python > #15567 > unrolled thread

Feature Request (docu): Define "dsc-file"

Back to article view | Back to linux.debian.maint.python

Contents

  Feature Request (docu): Define "dsc-file" c.buhtz@posteo.jp - 2024-03-15 08:50 +0100
    Re: Feature Request (docu): Define "dsc-file" Andreas Tille <andreas@an3as.eu> - 2024-03-15 11:10 +0100
      Re: Feature Request (docu): Define "dsc-file" c.buhtz@posteo.jp - 2024-03-15 12:10 +0100
        Re: Feature Request (docu): Define "dsc-file" Andreas Tille <andreas@an3as.eu> - 2024-03-15 13:40 +0100
    Re: Feature Request (docu): Define "dsc-file" Andrey Rakhmatullin <wrar@debian.org> - 2024-03-15 11:40 +0100
    Re: Feature Request (docu): Define "dsc-file" c.buhtz@posteo.jp - 2024-03-15 12:20 +0100

#15567 — Feature Request (docu): Define "dsc-file"

Hi,

this is a feature request to someone who has access and the knowledge to 
improve.

Description of the problem:

The second paragraph in 
<https://wiki.debian.org/Python/GitPackaging#Creating_a_new_package> 
tell me about importing a "dsc-file" without explaining what a dsc-file 
is or why I have to import it. The knowledge background is missing.

There is a hyper link behind the text "import an existing .dsc file" 
pointing to <https://wiki.debian.org/PackagingWithGit/GitDpm/ImportDsc>. 
Regarding that URL I assume this wiki entry is not maintained by DPT. 
But it also do not explain about dsc-file.

Suggested solution:
Create or locate the dsc-file definition in the wiki. It should be an 
extra page. Then just use a hyperlink in your own docu to point to that 
definition.

     "import an existing .dsc file"
      ^^^^^^             ^^^^^^^^^
      I                  L <https://wiki.debian.org/DSC-DEFINITION>
      L <https://wiki.debian.org/PackagingWithGit/GitDpm/ImportDsc>

Please let me know if there is another "channel" where I should open 
such requests.

Thanks in advance
Christian Buhtz

[toc] | [next] | [standalone]

#15573

Hi

Am Fri, Mar 15, 2024 at 07:39:39AM +0000 schrieb c.buhtz@posteo.jp:
> Hi,
> 
> this is a feature request to someone who has access and the knowledge to
> improve.
> 
> Description of the problem:
> 
> The second paragraph in
> <https://wiki.debian.org/Python/GitPackaging#Creating_a_new_package> tell me
> about importing a "dsc-file" without explaining what a dsc-file is or why I
> have to import it. The knowledge background is missing.

Please try a web search for instance with the terms

    debian source format dsc file

which brought several helpful links.  Alternatively you can ask ChatGPT,
Gemini or the LLM of your choice

    Can you explain what "import an existing .dsc file" means?

which produced a very verbose and good understandable text for me.

I do not think that things which are easy to find and is pretty clear
for the average reader of the text you want to extend should be written
down here.

Thank you for your suggestion anyway
    Andreas.

 
> There is a hyper link behind the text "import an existing .dsc file"
> pointing to <https://wiki.debian.org/PackagingWithGit/GitDpm/ImportDsc>.
> Regarding that URL I assume this wiki entry is not maintained by DPT. But it
> also do not explain about dsc-file.
> 
> Suggested solution:
> Create or locate the dsc-file definition in the wiki. It should be an extra
> page. Then just use a hyperlink in your own docu to point to that
> definition.
> 
>     "import an existing .dsc file"
>      ^^^^^^             ^^^^^^^^^
>      I                  L <https://wiki.debian.org/DSC-DEFINITION>
>      L <https://wiki.debian.org/PackagingWithGit/GitDpm/ImportDsc>
> 
> Please let me know if there is another "channel" where I should open such
> requests.
> 
> Thanks in advance
> Christian Buhtz
> 
> 

-- 
http://fam-tille.de

[toc] | [prev] | [next] | [standalone]

#15578

Thanks for all your answers.

Am 15.03.2024 11:07 schrieb Andreas Tille:
> Please try a web search for instance with the terms
> [...]
> which brought several helpful links.  Alternatively you can ask 
> ChatGPT,
> Gemini or the LLM of your choice

I am a bit shocked about that advise. For what was Hypertext invented?

My mail was not a support question but a Feature Request. Of course I am 
able to search this myself. But this won't help future readers and also 
won't improve the quality of the docs. The latter is my intention.

Basic knowledge is needed to understand? Of course this is always the 
case in every section of live and the world.
But why not point to that knowledge? That is what Hypertext is invented 
for.

> I do not think that things which are easy to find

No it is not "easy" when I have to run search engine for it. It is also 
not sustainable.

> and is pretty clear
> for the average reader of the text you want to extend should be written
> down here.

I don't understand that section.

[toc] | [prev] | [next] | [standalone]

#15583

Hi again,

Am Fri, Mar 15, 2024 at 11:06:13AM +0000 schrieb c.buhtz@posteo.jp:
> Thanks for all your answers.
> 
> Am 15.03.2024 11:07 schrieb Andreas Tille:
> > Please try a web search for instance with the terms
> > [...]
> > which brought several helpful links.  Alternatively you can ask ChatGPT,
> > Gemini or the LLM of your choice
> 
> I am a bit shocked about that advise. For what was Hypertext invented?

Sorry if I might have been a bit blunt. I admit you Wiki changes are OK.

> My mail was not a support question but a Feature Request. Of course I am
> able to search this myself. But this won't help future readers and also
> won't improve the quality of the docs. The latter is my intention.

I'm fine if someone wants to improve the docs.

> Basic knowledge is needed to understand? Of course this is always the case
> in every section of live and the world.
> But why not point to that knowledge? That is what Hypertext is invented for.
> 
> > I do not think that things which are easy to find
> 
> No it is not "easy" when I have to run search engine for it. It is also not
> sustainable.

Well, I'm usually a fan of letting newcomers enhance the docs since
experts might fail to see beginners hurdles.  I admit I was afraid that
the request would end up explaining very basic packaging stuff at places
where the topic is specific about using Git for the Python team.

> > and is pretty clear
> > for the average reader of the text you want to extend should be written
> > down here.
> 
> I don't understand that section.
 
I mean that the topic of that page is "Using git for team packages" and
we should not blur that topic with information which is very basic for
the intended user audience.  Adding a hyperlink as you did is OK.
Explaining .dsc format is over the top IMHO.

To make sure you will not misunderstand me:  I did not wanted to scare
away a newcomer by redirecting to other resources of information.  I
hope that my hints where helpful enough for you to know now what .dsc
is.

Kind regards
   Andreas.

-- 
http://fam-tille.de

[toc] | [prev] | [next] | [standalone]

#15576

[Multipart message — attachments visible in raw view] — view raw

On Fri, Mar 15, 2024 at 07:39:39AM +0000, c.buhtz@posteo.jp wrote:
> Hi,
> 
> this is a feature request to someone who has access and the knowledge to
> improve.
> 
> Description of the problem:
> 
> The second paragraph in
> <https://wiki.debian.org/Python/GitPackaging#Creating_a_new_package> tell me
> about importing a "dsc-file" without explaining what a dsc-file is or why I
> have to import it. The knowledge background is missing.
Most of the Debian packaging docs assume at least basic knowledge about
Debian source and binary packages.

> Suggested solution:
> Create or locate the dsc-file definition in the wiki. 
I'm not sure if it makes sense to cross-link basic stuff on all wiki
pages, to be honest. But that's
https://wiki.debian.org/Packaging/SourcePackage


-- 
WBR, wRAR

[toc] | [prev] | [next] | [standalone]

#15581

Close via 
https://wiki.debian.org/Python/GitPackaging?action=diff&rev1=97&rev2=98

[toc] | [prev] | [standalone]

Back to top | Article view | linux.debian.maint.python

csiph-web