Difference between revisions of "Developer Documents"

From BRL-CAD
(talk about mime types)
m (Reverted edits by BararaWayne (talk) to last revision by Sean)
(37 intermediate revisions by 17 users not shown)
Line 1: Line 1:
= Projects under active development =
+
[[Category:Design Documents]]
 +
[[category:Projects]]
  
* [[libpg : A parametrics/constraint library]]
+
== Introduction ==
 +
If you are going to contribute and wish to be the part of ongoing development of BRL-CAD, you are highly recommended to read following introductory article to let you know the current roadmap of the project.
 +
 
 +
[[An Introduction To New Developers]]
 +
 
 +
== Development Projects ==
 +
 
 +
* [[libpg : A parametrics/constraint library]] (old documentation)
 +
* [[libpc | libpc : Geometric Constraint Solving]]
 
* [[Revolve Primitive]]
 
* [[Revolve Primitive]]
 
* [[OpenGL GUI Framework]]
 
* [[OpenGL GUI Framework]]
 
* [[Metropolis_Light_Transport|Global Illumination using Metropolis Light Transport]]
 
* [[Metropolis_Light_Transport|Global Illumination using Metropolis Light Transport]]
 
* [[Geometry Service]]
 
* [[Geometry Service]]
 +
* [[BRL-CAD's core C++ interface]]
 +
* [[Online Geometry]]
 +
 +
== Developer FAQ ==
  
= Developer FAQ =
+
=== I'm interested in BRL-CAD development. How can I get involved? ===
  
== I'm trying to add a new file to the repository and I get an error on commit about mime types. What do I do? ==
+
* Join the IRC channel #brlcad at irc.freenode.net and/or the [http://lists.sourceforge.net/lists/listinfo/brlcad-devel developer mailing list]
 +
* Read the [https://brlcad.svn.sourceforge.net/viewvc/*checkout*/brlcad/brlcad/trunk/HACKING developer's guide]
 +
* Start [http://sourceforge.net/tracker/?func=add&group_id=105292&atid=640804 submitting patches]
  
You either set up your subversion config to auto-set mime types or you directly set the mime type on the file before you commit the file using svn propset.
+
=== I'm trying to add a new file to the repository and I get an error on commit about mime types. What should I do? ===
  
Sean provides a copy of his Subversion config file that accounts for many mime types. You can download and install it with this:
+
You should set the mime type. See [[mime-types]] for more information.
  
'''curl http://brlcad.org/~sean/subversion.config > ~/.subversion/config'''
+
== Developer Examples ==
  
This problem usually looks like this:
+
* [[Example_db_walk_tree|Using db_walk_tree()]]
 +
* [[:Category:Code examples]]
  
Transmitting file data ...svn: Commit failed (details follow):
+
== Development Tips ==
svn: MERGE request failed on '/svnroot/brlcad/brlcad/trunk/regress'
+
* [[Compiling]]
svn: 'pre-commit' hook failed with error output:
+
* [[Emacs]]
/var/local/mastertree/service-svn/hook-scripts/check-mime-type.pl:
+
* [[Visual Studio]]
 
brlcad/trunk/regress/some_new_file.c : svn:mime-type is not set
 
 
 
    Every added file must have the svn:mime-type property set. In
 
    addition text files must have the svn:eol-style property set.
 
   
 
    For binary files try running
 
    svn propset svn:mime-type application/octet-stream path/of/file
 
   
 
    For text files try
 
    svn propset svn:mime-type text/plain path/of/file
 
    svn propset svn:eol-style native path/of/file
 
   
 
    You may want to consider uncommenting the auto-props section
 
    in your ~/.subversion/config file. Read the Subversion book
 
    (http://svnbook.red-bean.com/), Chapter 7, Properties section,
 
    Automatic Property Setting subsection for more help.
 

Revision as of 10:35, 12 March 2016


Introduction

If you are going to contribute and wish to be the part of ongoing development of BRL-CAD, you are highly recommended to read following introductory article to let you know the current roadmap of the project.

An Introduction To New Developers

Development Projects

Developer FAQ

I'm interested in BRL-CAD development. How can I get involved?

I'm trying to add a new file to the repository and I get an error on commit about mime types. What should I do?

You should set the mime type. See mime-types for more information.

Developer Examples

Development Tips