savannah-hackers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Savannah-hackers] savannah.gnu.org: submission of Mx Documentation


From: Loic Dachary
Subject: Re: [Savannah-hackers] savannah.gnu.org: submission of Mx Documentation Tool
Date: Wed, 16 Jan 2002 08:47:48 +0100

        Hi,

        Including a file with the GNU GPL in a distribution is
(unfortunately :-) ) not enough to make a program Free Software. You should
also apply the GNU GPL to the software is the way described below. Also note
that these instructions are an integral part of the GNU GPL and may not
be removed from the COPYING file. 

        Could you please submit your project again when you've done the
necessary modifications ?

        Thanks in advance,

 How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary.  Here is a sample; alter the names:

  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.

  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice

This General Public License does not permit incorporating your program into
proprietary programs.  If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library.  If this is what you want to do, use the GNU Library General
Public License instead of this License.

address@hidden writes:
 > A package was submitted to savannah.gnu.org.
 > This mail was sent to address@hidden, address@hidden
 > 
 > 
 > Erwan Loisant <address@hidden> described the package as follows:
 > License: gpl
 > Other License: 
 > Package: Mx Documentation Tool
 > System name: mx
 > This package does NOT want to apply for inclusion in the GNU project
 > 
 >  The Mx documentation tool has been developed to improve the quality of 
 > program documentation. In particular, all program modules are written as if 
 > they form part of a final, and completely documented system.That is, the 
 > source code can be elicitated in the native language, motivating its design, 
 > assumptions, and behavior. Using a text formatter enables the programmer to 
 > express more clearly the program properties. Just consider a pictorial 
 > presentation of the program structure or an assertion on a set of variables, 
 > typeset in a mathematical style. The result is a more readable document 
 > where the actual program code plays the role of an illustration of the more 
 > global system objectives and design boundaries. The programmer works with Mx 
 > files rather than program source files. Therefore, the programmer uses 
 > special Mx-directives, to separate the code sections from the documentation 
 > sections. The overhead involved in writing a program as a Mx-document is 
 > kept minimal. Likewise, the overhead incurred on the edit-compile-debug 
 > cycle is kept at a minimum. For example, for C-based code fragments Mx 
 > generates compiler directives that enables you to debug the system in terms 
 > of Mx-documents, rather than the C-source files extracted. Using Mx during 
 > the whole software development cycle leads to a product where the 
 > documentation is in sink with the program itself. Moreover, the physical 
 > adjanceny of documentation containing rationale and assumptions stimulates 
 > the delivery of better quality code, because discrepancies in design and 
 > coding are more easily recognized.

 > 

 > It already exists and you can see it at http://jadawin.free.fr/mx
 > 
 > 
 > 

-- 
Loic   Dachary         http://www.dachary.org/  address@hidden
12 bd  Magenta         http://www.senga.org/      address@hidden
75010    Paris         T: 33 1 42 45 07 97          address@hidden
        GPG Public Key: http://www.dachary.org/loic/gpg.txt

reply via email to

[Prev in Thread] Current Thread [Next in Thread]