Brad and Chris: Agreed that this is more of an implementation note than a user guide. I looked at the structure of the doc directory for something similar and didn't find it. So I suggested lumping it in with other READMEs only for lack of a better idea.
I like the notion of putting it with the source code. In case we decided to convert it to Doxygen format in the future, the file could be found from the source through a short relative path. THH ________________________________________ From: Brad Chamberlain [[email protected]] Sent: Thursday, April 10, 2014 10:12 AM To: Chris Wailes Cc: Chapel Sourceforge Developers List Subject: Re: [Chapel-developers] [Chapel-commits] SF.net SVN: chapel:[23172] trunk/doc/release/technotes/README. partialInstantiation [Tom, if you feel I'm missing something crucial below, please let me know]. Having a bit more time today, I opened up the README and continue to think that it should be moved. The READMEs in doc/release/technotes/ are all very end-user oriented, explaining how to use particular features in the language and implementation (things that should eventually find their way into either the language spec or chpldoc-based library documentation). Unless I'm completely misunderstanding, README.partialInstantiation seems to be very developer-oriented. For that reason, I think doc/devel/ would be a more appropriate place for it in the doc/ hierarchy. Unfortunately, it doesn't have a number of equivalent sibling READMEs there, so (IMO), it could either go at the top-level (which is where most orphans seem to go until there are enough of them that are similar to warrant a subdirectory), or the compilerOverview/ directory, or a new subdirectory. That said, I also find myself wondering whether the compiler/resolution directory would be the best place for it, to keep it near the source code that it refers to... It might be less likely to be overlooked there by people who might benefit from it? -Brad On Thu, 10 Apr 2014, Chris Wailes wrote: > Tom suggested that I put the README there. I'm fine with moving it if you > think it would find a more appropriate home in doc/devel. > > - Chris > > > On Wed, Apr 9, 2014 at 1:56 PM, Brad Chamberlain <[email protected]> wrote: > >> >> Without opening it, it seems to me that this document is intended more for >> developers than for end-users and therefore shouldn't go in the release, >> but rather in doc/devel somewhere... Or am I mis-guessing at its intent? >> >> -BRad >> >> >> On Wed, 9 Apr 2014, [email protected] wrote: >> >>> Revision: 23172 >>> http://sourceforge.net/p/chapel/code/23172 >>> Author: chriswailes >>> Date: 2014-04-09 14:59:07 +0000 (Wed, 09 Apr 2014) >>> Log Message: >>> ----------- >>> Added a README that was supposed to be added in r23156. >>> >>> Revision Links: >>> -------------- >>> http://sourceforge.net/p/chapel/code/23156 >>> >>> Added Paths: >>> ----------- >>> trunk/doc/release/technotes/README.partialInstantiation >>> >>> This was sent by the SourceForge.net collaborative development platform, >> the world's largest Open Source development site. >>> >>> >>> >> ------------------------------------------------------------------------------ >>> Put Bad Developers to Shame >>> Dominate Development with Jenkins Continuous Integration >>> Continuously Automate Build, Test & Deployment >>> Start a new project now. Try Jenkins in the cloud. >>> http://p.sf.net/sfu/13600_Cloudbees >>> _______________________________________________ >>> Chapel-commits mailing list >>> [email protected] >>> https://lists.sourceforge.net/lists/listinfo/chapel-commits >>> >> >> >> ------------------------------------------------------------------------------ >> Put Bad Developers to Shame >> Dominate Development with Jenkins Continuous Integration >> Continuously Automate Build, Test & Deployment >> Start a new project now. Try Jenkins in the cloud. >> http://p.sf.net/sfu/13600_Cloudbees >> _______________________________________________ >> Chapel-developers mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/chapel-developers >> > ------------------------------------------------------------------------------ Put Bad Developers to Shame Dominate Development with Jenkins Continuous Integration Continuously Automate Build, Test & Deployment Start a new project now. Try Jenkins in the cloud. http://p.sf.net/sfu/13600_Cloudbees _______________________________________________ Chapel-developers mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/chapel-developers ------------------------------------------------------------------------------ Put Bad Developers to Shame Dominate Development with Jenkins Continuous Integration Continuously Automate Build, Test & Deployment Start a new project now. Try Jenkins in the cloud. http://p.sf.net/sfu/13600_Cloudbees _______________________________________________ Chapel-developers mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/chapel-developers
