 |
 | Home | Contact Us | FAQ | Search & Site Map | Link to Us |
 | Sign In | Join | Other 45 Sites in Network |
| HomeDiscussion GroupsGeneralPHPASPPerlColdFusionFlashHTML, CSS, ScriptsBrowsers |
Webmaster Forum / Perl / Modules / April 2007newbie question: how to change documentation
I have just uploaded my first module. I have read that there is an exception from the rule "never the same file again" concerning docu files (an *.html file is my case). But I could not find (if possible at all) how can I change a documentation file that is part of my module distribution. Does it work, perhaps, that I upload the whole module (a gzipped tar file) again, under the same version/name, with the only difference in the package being a changed .html file? Or should I upload that file separately (but how it can be linked to the module?) ? Many thanks for a help, and I am sorry to bother you with such newbie question. Cheers, Martin  SignatureMartin Senger email: martin.senger@gmail.com skype: martinsenger > I have just uploaded my first module. I have read that there is an > exception from the rule "never the same file again" concerning docu files [quoted text clipped - 4 lines] > being a changed .html file? Or should I upload that file separately (but > how it can be linked to the module?) ? Please don't upload two different distributions with the same filename. Instead, you can trailing digits: Namespace-Module-0.0101.tar.gz ^^ Regards, Shlomi Fish --------------------------------------------------------------------- Shlomi Fish shlomif@iglu.org.il Homepage: http://www.shlomifish.org/ If it's not in my E-mail it doesn't happen. And if my E-mail is saying one thing, and everything else says something else - E-mail will conquer. -- An Israeli Linuxer > Please don't upload two different distributions with the same filename. > Instead, you can trailing digits: > > Namespace-Module-0.0101.tar.gz > ^^ Many thanks for helping me. I was actually asking how to use the "exception" I have found on the PAUSE pages: "For security reasons you will never be able to upload a file with identical name again. This strict requirement does have one exception: documentation files may be overwritten. There's a simple regular expression that draws the line between docu und code: /(readme|\.html|\.txt|\.[xy]ml|\.[pr]df|\.pod)$/i. Filenames matching this regexp can be uploaded as often as you like." I am afraid that I am not sure if and how I can use this exception (I just need to change one hyperlink in one of my documentation HTML files in my module distribution). But perhaps your answer means "do not use this exception". Am I right? Regards, Martin SignatureMartin Senger email: martin.senger@gmail.com skype: martinsenger * Martin Senger <martin.senger@gmail.com> [2007-04-30 13:40]: > I am afraid that I am not sure if and how I can use this > exception (I just need to change one hyperlink in one of my > documentation HTML files in my module distribution). You can’t. Your HTML is inside a tarball, which is what you uploaded, and the name of what you uploaded does not match the given regex, so the exception does not apply to it. You’ll have to upload a new version. Regards, SignatureAristotle Pagaltzis // <http://plasmasturm.org/> > Please don't upload two different distributions with the same filename. > > But perhaps your answer means "do not use this exception". Am I right? Indeed. Various third-party packaging systems (e.g. FreeBSD ports) get *very* confused when distributions change without a change in version numbers. Even though you only changed the docs, just bump the version number, and document in your Changes file what happened, and that people don't necessarily need to upgrade. Appending additional digits, as Shlomi suggested, is not optimal, since it can lead to ambiguity when you remove those digits again. E.g. when comparing 0.0101 and 0.02, it is not universally clear which is higher. There is at least one packaging system out there that *will* get it wrong. /Lars Many thanks to all of you. I followed your advise and uploaded under a completely new version number. Many thanks again. Best regards, Martin SignatureMartin Senger email: martin.senger@gmail.com skype: martinsenger |
Reply to this Message |
 Sign In
 Join
 My Latest Posts My Monitored Threads My Blog My Photo Gallery My Profile My Homepage Start New Thread Enable EMail Alerts Rate this Thread
|
©2009 Advenet LLC Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.