Menu
▾
▴
[Gearbox-commit] SF.net SVN: gearbox: [38] gearbox/trunk/doc
|
From: <rus...@us...> - 2008-02-08 05:17:21
|
Revision: 38
http://gearbox.svn.sourceforge.net/gearbox/?rev=38&view=rev
Author: russo2503v
Date: 2008-02-07 21:17:21 -0800 (Thu, 07 Feb 2008)
Log Message:
-----------
Modified Paths:
--------------
gearbox/trunk/doc/index.dox
gearbox/trunk/doc/overview.dox
gearbox/trunk/doc/principles.dox
Removed Paths:
-------------
gearbox/trunk/doc/constitution.dox
gearbox/trunk/doc/license.dox
Deleted: gearbox/trunk/doc/constitution.dox
===================================================================
--- gearbox/trunk/doc/constitution.dox 2008-02-08 05:00:18 UTC (rev 37)
+++ gearbox/trunk/doc/constitution.dox 2008-02-08 05:17:21 UTC (rev 38)
@@ -1,104 +0,0 @@
-/*
- * GearBox Project: Components for robotics
- * http://gearbox.sf.net/
- * Copyright (c) 2008 GearBox Team
- *
- * This copy of GearBox is licensed to you under the terms described in the
- * the LICENSE file included in this distribution.
- *
- */
-
-/*!
-
-@page gbx_doc_constitution GearBox Constitution
-
-1. TECHNICAL CHOICES RELATED TO PROJECT SETUP
-- build system: [CMake]
-- revision control system: [svn]
-- unit test system: [CTest]
-- documentation: [Doxygen]
-- hosting service: [SorceForge]
-- bug tracking: [Trac]
-- name [Gearbox]
-
-2. CONSTRAINTS ON PROJECT OPERATION
-
-2.1 Source code life cycle
-@image html gbx_src_life_cycle.png
-
-2.2.1 Criteria for acceptance into sandbox
-- relevance: [Any reusable software related to robotics. Emphasis on
-algorithm and driver implementations. Integration frameworks are
-generally discouraged. Relevance of a particular library is determined
-through mailing list discussion.]
-- license [must specify *an* open source license]
-- copyright [must specify ownership]
-
-2.2.2 Criteria for acceptance into distribution
-- documentation [sufficient to be useful, depends on the complexity of
-software, determined by peer review (at least 1 reviewer) and a public
-discussion on the mailing list.]
-- tests and sample code [sufficient to be useful, depends on software,
-determined by peer review.]
-- programming style [must name a known style, or describe a style (see
-Appendix A), and adhere to it]
-- compilation [must compile without warnings (with -Wall) on all
-supported platforms with all supported compilers.
-- operation [Libraries must operate (within reason) as described by the
-documentation. Reviewers of hardware drivers are encouraged to have
-access to hardware where feasible.]
-
-2.2.3 Criteria for a warning
-- all of 2.2.2 [failure of any in 2.2.2]
-
-2.2.4 Criteria for disabling
-- compilation [fails to compile on any one of the supported
-platforms/complilers (as specified by the library developer) or does not
-gracefully handle one of the platforms/compilers specified as supported
-by Gearbox but not supported by that library - will be disabled
-immediatly in SVN and in any following releases until fixed]
-
-2.2.5 Criteria for retirement from the distribution
-- compilation [fails for 2 months since disabling to compile on any one
-of the supported platforms/complilers (as specified by the library
-developer) or does not gracefully handle one of the platforms/compilers
-specified as supported by Gearbox but not supported by that library -
-will be moved to graveyard at the end of the 2nd month]
-- other in 2.2.2 [failure of any in 2.2.2 for 3 months since warning]
-
-2.3 Release of source code
-[Regular frequent releases every 1.5-3 months.]
-
-2.4 Ownership of source code
-[Copyright belongs to authors and major contributors]
-
-3. FREEDOMS
-[
-Aside from complying with Sec.2, the designer of every module within the
-project is not constrained in any way. We specifically mention several
-important freedoms:
-- OS, compiler, programming language. New contributor's responsibility
-is to make sure that the new addition does not break the existing code.
-- code design, e.g. whether or not to use C++ exceptions.
-- dependencies
-- data types used by libraries
-]
-
-A. Programming Style
-
-In the case of not using a well-known, named style, contributors must
-describe the programming style in sufficient detail for others to be
-able to adhere to it (assuming, of course, that others are also capable
-of looking at the code for details). An example of what is necessary for
-C++ is given below.
-
-- Naming conventions:
- - variables, member variables, classes, structs, namespaces
- - functions, member functions
- - #defines, enums
- - filenames
- - API usage style
-- Units and coordinate systems, if applicable (needless to say that the
-units and CS's of the API must be documented separately, this applies to
-the code itself.)
-*/
Modified: gearbox/trunk/doc/index.dox
===================================================================
--- gearbox/trunk/doc/index.dox 2008-02-08 05:00:18 UTC (rev 37)
+++ gearbox/trunk/doc/index.dox 2008-02-08 05:17:21 UTC (rev 38)
@@ -37,7 +37,7 @@
@section gbx_doc_index_more_info Where to start
- Read general information about the project: @ref gbx_doc_overview
-- Read on how the project operates: @ref gbx_doc_principles
+- See how the project operates: @ref gbx_doc_principles
- Get set up: @ref gbx_doc_getting
- Browse through the <strong><a href="modules.html" style="text-decoration:none">currently available software</a></strong><br>
Deleted: gearbox/trunk/doc/license.dox
===================================================================
--- gearbox/trunk/doc/license.dox 2008-02-08 05:00:18 UTC (rev 37)
+++ gearbox/trunk/doc/license.dox 2008-02-08 05:17:21 UTC (rev 38)
@@ -1,39 +0,0 @@
-/*
- * GearBox Project: Components for robotics
- * http://gearbox.sf.net/
- * Copyright (c) 2008 GearBox Team
- *
- * This copy of GearBox is licensed to you under the terms described in the
- * the LICENSE file included in this distribution.
- *
- */
-
-/*!
-
-@page gbx_doc_license GearBox License and Copyright
-
-@section gbx_doc_license_license License
-
-The GearBox project does not, as a policy, require code to conform to any
-specific license to be included in the distribution. However, the code is required
-to have a license and the license must be Open Source. That is the official policy.
-
-For a complete up-to-date list of licenses see the @b LICENSE file included in your distribution.
-
-Generally speaking, most of the code in the GearBox libraries and components is covered under the <a href="http://www.fsf.org/copyleft/lgpl.html" target="_blank">Library GNU Public License (LGPL)</a> as defined by the Free Software Foundation (FSF). Most of the remaining code is licensed under the <a href="http://www.fsf.org/copyleft/gpl.html" target="_blank">GNU Public License (GPL)</a>, also defined by the FSF.
-
-The LGPL (as opposed to the GPL) is used whenever possible to allow commercial enterprises to build closed-source products using GearBox technology.
-
-@section gbx_doc_license_copyright Copyright
-
-Copyright belongs to developers and major contributors. The copyright is recorded in a comment block at the top of every source file. We would like to leave it up to the current copyright holders to distinguish between "major" and "minor" contributions.
-
-Here's how it works. The creators of newly-added code put their names as copyright holders. Major contributions by other people are acknowledged by the current copyright holders by adding new names.
-
-In other words:
-- if you are not on the list: don't add yourself.
-- if you are on the list: be nice to others.
-
-It seems fair.
-
-*/
Modified: gearbox/trunk/doc/overview.dox
===================================================================
--- gearbox/trunk/doc/overview.dox 2008-02-08 05:00:18 UTC (rev 37)
+++ gearbox/trunk/doc/overview.dox 2008-02-08 05:17:21 UTC (rev 38)
@@ -1,5 +1,5 @@
/*
- * GearBox Project: Components for robotics
+ * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
* http://gearbox.sf.net/
* Copyright (c) 2008 GearBox Team
*
@@ -14,22 +14,28 @@
@par Goals
-Insert from new documents.
+Provide software tools which could be integrated into complete systems with one of many software integration frameworks.
-@ref gbx_doc_principles
+@par Licence
-@par Licence and Copyright
+The GearBox project does not, as a policy, require code to conform to any
+specific license to be included in the distribution. However, the code is required
+to have a license and the license must be Open Source. That is the official policy.
-- GearBox software is released under open source licenses. For a complete up-to-date list of licenses see the @b LICENSE file included in your distribution.
-- Copyright belongs to developers and major contributors.
-- @ref gbx_doc_license "Read more..."
+For a complete up-to-date list of licenses see the @b LICENSE file included in your distribution.
+@par Copyright
+
+Copyright belongs to developers and major contributors. The copyright is recorded in a comment block at the top of every source file.
+
+@par Complete Description of Rules
+
+For a complete set of project rules see @ref gbx_doc_principles
+
@par OS support
-- full Linux support
+In principle GearBox can be deployed as widely as CMake allows. For a detailed list of OS support see the list of <strong><a href="modules.html" style="text-decoration:none">currently available software</a></strong>.
-In principle GearBox can be deployed as widely as CMake allows.
-
@par History
Insert once history is available.
Modified: gearbox/trunk/doc/principles.dox
===================================================================
--- gearbox/trunk/doc/principles.dox 2008-02-08 05:00:18 UTC (rev 37)
+++ gearbox/trunk/doc/principles.dox 2008-02-08 05:17:21 UTC (rev 38)
@@ -137,7 +137,7 @@
@subsection gbx_doc_principles_operation_ownership 2.3 Ownership of source code
-Copyright belongs to authors and major contributors.
+Copyright belongs to authors and major contributors. The copyright is recorded in a comment block at the top of every source file. It is up to the current copyright holders to distinguish between "major" and "minor" contributions.
@section gbx_doc_principles_freedoms 3. Freedoms
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|