diff options
| author | Nicolas Vigier <boklm@mageia.org> | 2013-04-14 13:46:12 +0000 |
|---|---|---|
| committer | Nicolas Vigier <boklm@mageia.org> | 2013-04-14 13:46:12 +0000 |
| commit | 1be510f9529cb082f802408b472a77d074b394c0 (patch) | |
| tree | b175f9d5fcb107576dabc768e7bd04d4a3e491a0 /zarb-ml/mageia-dev/2011-August/007482.html | |
| parent | fa5098cf210b23ab4f419913e28af7b1b07dafb2 (diff) | |
| download | archives-1be510f9529cb082f802408b472a77d074b394c0.tar archives-1be510f9529cb082f802408b472a77d074b394c0.tar.gz archives-1be510f9529cb082f802408b472a77d074b394c0.tar.bz2 archives-1be510f9529cb082f802408b472a77d074b394c0.tar.xz archives-1be510f9529cb082f802408b472a77d074b394c0.zip | |
Diffstat (limited to 'zarb-ml/mageia-dev/2011-August/007482.html')
| -rw-r--r-- | zarb-ml/mageia-dev/2011-August/007482.html | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/zarb-ml/mageia-dev/2011-August/007482.html b/zarb-ml/mageia-dev/2011-August/007482.html new file mode 100644 index 000000000..fae495b02 --- /dev/null +++ b/zarb-ml/mageia-dev/2011-August/007482.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML> + <HEAD> + <TITLE> [Mageia-dev] Suggest summary documentation of Mageia perl routines + </TITLE> + <LINK REL="Index" HREF="index.html" > + <LINK REL="made" HREF="mailto:mageia-dev%40mageia.org?Subject=Re%3A%20%5BMageia-dev%5D%0A%20%3D%3Futf-8%3Fq%3FSuggest_summary_documentation_of_Mageia_pe%3F%3D%0A%20%3D%3Futf-8%3Fq%3Frl%3D09routines%3F%3D&In-Reply-To=%3C201108240924.43411.bgmilne%40staff.telkomsa.net%3E"> + <META NAME="robots" CONTENT="index,nofollow"> + <META http-equiv="Content-Type" content="text/html; charset=us-ascii"> + <LINK REL="Previous" HREF="007477.html"> + <LINK REL="Next" HREF="007486.html"> + </HEAD> + <BODY BGCOLOR="#ffffff"> + <H1>[Mageia-dev] Suggest summary documentation of Mageia perl routines</H1> + <B>Buchan Milne</B> + <A HREF="mailto:mageia-dev%40mageia.org?Subject=Re%3A%20%5BMageia-dev%5D%0A%20%3D%3Futf-8%3Fq%3FSuggest_summary_documentation_of_Mageia_pe%3F%3D%0A%20%3D%3Futf-8%3Fq%3Frl%3D09routines%3F%3D&In-Reply-To=%3C201108240924.43411.bgmilne%40staff.telkomsa.net%3E" + TITLE="[Mageia-dev] Suggest summary documentation of Mageia perl routines">bgmilne at staff.telkomsa.net + </A><BR> + <I>Wed Aug 24 09:24:40 CEST 2011</I> + <P><UL> + <LI>Previous message: <A HREF="007477.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines +</A></li> + <LI>Next message: <A HREF="007486.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines +</A></li> + <LI> <B>Messages sorted by:</B> + <a href="date.html#7482">[ date ]</a> + <a href="thread.html#7482">[ thread ]</a> + <a href="subject.html#7482">[ subject ]</a> + <a href="author.html#7482">[ author ]</a> + </LI> + </UL> + <HR> +<!--beginarticle--> +<PRE>On Wednesday, 24 August 2011 08:31:51 andre999 wrote: +><i> Thierry Vignaud a écrit : +</I>><i> > On 23 August 2011 15:46, Jerome Quelin<<A HREF="https://www.mageia.org/mailman/listinfo/mageia-dev">jquelin at gmail.com</A>> wrote: +</I>><i> >> On 11/08/23 15:40 +0200, Thierry Vignaud wrote: +</I>><i> >>> Which one jquelin is reffering to? +</I>><i> >> +</I>><i> >> none. i'm maintaining perl& perl modules for mageia, but am not a drak* +</I>><i> >> contributor. +</I>><i> > +</I>><i> > OK, I was mistaken by "a post by jquelin reminded me of something that +</I>><i> > would be nice to see" +</I>><i> +</I>><i> my fault ... a comment he made about something unrelated reminded me of +</I>><i> this idea. I've been wanting to contribute to drak* for some time. +</I>><i> (but readily distracted by other things) +</I>><i> +</I>><i> Something like : +</I>><i> ---- +</I>><i> routine: foo(parm1, parm2, ...) +</I>><i> path: .../{filename} +</I>><i> purpose: ... +</I>><i> parm1 = ... +</I>><i> parm2 = ... +</I>><i> ---- +</I>><i> for each routine, without any details of internals. +</I>><i> (Essentially, what does the black box do.) +</I>><i> The path is useful if more than one function has the same name, as well as +</I>><i> examining internals if wanted. +</I>><i> +</I>><i> Basically I was thinking of Mageia-specific perl routines. +</I>><i> I started deciphering rpmdrake back on mdv, and did a cludge to rearrange +</I>><i> the main screen, but not being familiar with the invoked routines was a +</I>><i> big handicap for doing more. +</I>><i> You gave me some useful tips at the time. +</I>><i> +</I>><i> I could make a script to extract the routine names + paths, but at least +</I>><i> one line of comment in the perl code right after the routine name would be +</I>><i> very useful. (It could be just before - but that would be harder to +</I>><i> extract.) +</I> +Please use POD for this, the perldoc tool can extract it, no need to write +something to do it. The POD can be interleaved with the code (so it can be +both the comment and the documentation). + +Of course, it might also be an idea to refactor libDrakX (use a unique +namespace etc.). + +Regards, +Buchan + +Regards, +Buchan +</PRE> + + + + + + + + + + + + + + + + + + + + + + + + + + + +<!--endarticle--> + <HR> + <P><UL> + <!--threads--> + <LI>Previous message: <A HREF="007477.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines +</A></li> + <LI>Next message: <A HREF="007486.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines +</A></li> + <LI> <B>Messages sorted by:</B> + <a href="date.html#7482">[ date ]</a> + <a href="thread.html#7482">[ thread ]</a> + <a href="subject.html#7482">[ subject ]</a> + <a href="author.html#7482">[ author ]</a> + </LI> + </UL> + +<hr> +<a href="https://www.mageia.org/mailman/listinfo/mageia-dev">More information about the Mageia-dev +mailing list</a><br> +</body></html> |