Revision: 55785
http://sourceforge.net/p/brlcad/code/55785
Author: brlcad
Date: 2013-06-14 19:42:38 +0000 (Fri, 14 Jun 2013)
Log Message:
-----------
group the api (header) and user documentation tasks together. caen23 converted
the remaining manpages.
Modified Paths:
--------------
brlcad/trunk/TODO
Modified: brlcad/trunk/TODO
===================================================================
--- brlcad/trunk/TODO 2013-06-14 19:23:23 UTC (rev 55784)
+++ brlcad/trunk/TODO 2013-06-14 19:42:38 UTC (rev 55785)
@@ -64,7 +64,10 @@
one hit point is being returned. to reproduce:
e s.nos5g ; ae 35 25 ; units mm ; center 26912.4 7089.08 7168.96 ; nirt
+* improve compile-time version management -- port brlcad-version to
+ windows, reconsider providing compile-time header constants.
+
THESE ARE UNSCHEDULED BACKLOG TASKS
-----------------------------------
@@ -264,25 +267,9 @@
* Mac OS X mouse input binding problem seems to be back with rotations
stalling during interactive use.
-* group public library headers into subdirs, e.g. include/bu/bu.h, so
- it's clear when you're using headers from another library and
- breaking encapsulation.
-
* killall command reports db_lookup failures if the target object
doesn't exist (maybe we only care about refs). should keep quiet.
-* DocBook: create a DB index.xml to generate a doc listing (with
- hot links) for the html and pdf collection
-
-* DocBook source: fix all SEVERE messages for extradocs builds (html
- and pdf).
-
-* DocBook source: add xsl customizations for figure and table title
- positions, float centering, etc.; add automatic figure, table, and
- other similar references; add separate markup for html (role='html')
- and pdf (role='fo') image sizing and placement; remove unnecessary
- image markup; lift child namespaces to each document's root element.
-
* pixdiff reports bytes, but reports incorrect (off-by-one) bytes for
.bw input files. cause is due to tool assuming input is rgb triplets
(even though output is bytes, wtf?). should probably report pixels
@@ -430,19 +417,6 @@
improving workflows, documentation, robustness, and new development
areas.
-* update the msvc build to not use installTree.tcl -- the build
- shouldn't really be reliant upon tclsh or be all contained within
- the tclsh project. sub-projects should build and install by
- themselves (e.g. tkhtml3 should generate its htmltokens.h file).
- the "brlcad" project, if any, can build up the installation tree and
- generate the final installation exe.
-
-* implement namespacing for attributes as a means to group attributes
- together. this can predominantly be a naming convention, but
- requires awareness in the attribute-searching routines to search
- without the namespace unless one is specified, and to reserve :: in
- attribute names unless they're quoted.
-
* clean up default attributes to be consistent and upgrade old
attributes to their new names. includes likes of region, region_id,
material_id, air, los, rgb, oshader, and inherit. see
@@ -455,9 +429,6 @@
* implement rt_volume() API for computing geometry volume (g_qa style
for complex, direct for primitives)
-* improve compile-time version management -- port brlcad-version to
- windows, reconsider providing compile-time header constants.
-
* have gqa calculate the volume of overlapping regions, not just
shotline overlap distances. that will allow output to be sorted by
volumetrically significant regions and should eliminate a common
@@ -489,23 +460,10 @@
common code in src/libanalyze (there may be more candidates around
the tree)
-* all of the rt* tracers share common code and common options, but do
- not share common documentation. refactor documentation to use
- include directives so that there is one place where all of the
- common options are documented. update usage statements to reflect
- commonality as well.
-
-* document the saveview/loadview options. migrate them to libged if
- they're not already.
-
* make loadview still load the view if the database doesn't match the
currently open database, only load geometry as an option (and then
just ignore the db).
-* improve rtedge documentation, explain how it computes its "centroid"
- (as it's not exactly the center of bounding box of all objects -- it
- depends on the booleans).
-
* add a force option to the tracers to support overwriting the current
output file (so long as we're going to make it read-only by default).
@@ -601,12 +559,6 @@
* MINOR: add tolerance parameters to the bn_*() functions that have
near-zero tests.
-* complete conversion of existing manual pages into docbook format
-
- note that Eric Raymond's "manlifter" (a driver for his "doclifter")
- can be used to aid the project (see
- http://www.catb.org/~esr/doclifter/)
-
* add an option to bot_dump for outputting surface normals. Make sure
all supported dump formats (obj, dxf, etc.) optionally write out
normals. Consider adding an option to smoothly interpolate normals
@@ -614,10 +566,6 @@
* modify g_qa to search for >1 region flag in a tree path.
-* the binary windows installer is missing headers for our external
- dependencies (Tcl, zlib, and OpenNURBS in particular as the likes of
- bu.h and raytrace.h requires them)
-
* make rtarea display a cross-hair and perhaps coordinates for the
center of area if run from within mged.
@@ -693,14 +641,6 @@
base libs, it should disappear but shouldn't have wdb_*() funcs in
libged regardless. work in progress.
-* make our C headers C++-convenient with proper extern "C" wrapping.
-
-* reorganize the header files in include so it is clear which headers
- pertain to which libraries.
-
-* break up library headers into subheaders so includes can be more
- specific (and help speed up compilation) and locally documented.
-
* implement a jitter-style option to rt that makes it average the ray
results to take a weighted light contribution for a given
resolution. saves more memory over rendering at 2x/4x/8x/whatever
@@ -921,8 +861,6 @@
so you could return primitives to local coordinates. See sf feature
request 2826720 from cericole.
-* ensure successful build on mingw
-
* test for USE_FORKED_THREADS in configure
* optimize CSG structures automatically: automatic simplification,
@@ -952,8 +890,6 @@
* add callback data parameters to libpkg hook functions
-* add performance options for the intel compiler on Altix
-
* investigate performance impact of using sched_setaffinity and/or
pthread_attr_setaffinity_np for linux threading affinity in librt.
@@ -1112,14 +1048,6 @@
idea is proven in that command, it should be made into a libgcv routine
and convertors/other commands retargeted to use it.
-* write up some documentation on other build tools besides make -
- CMake supports other generators, wouldn't hurt to detail how to
- trigger builds in them (MSVC is partially covered, make sure to
- coverage is complete - others include Eclipse, XCode once we get
- the kinks ironed out there, CodeBlocks. New experimental ninja
- build tool and its (also experimental) CMake support are promising -
- if/when CMake support goes mainstream, document that too.)
-
* look into embedding both rgb[3] and complex[n] data types in a union to
allow unification of libmultispectral and liboptical APIs to a single
more general liboptical. Need to be careful about performance and
@@ -1291,6 +1219,12 @@
view (i.e., a grid of primary rays), and 3) rtgl point samples
(which is a variant of 2 but potentially view independent).
+* implement namespacing for attributes as a means to group attributes
+ together. this can predominantly be a naming convention, but
+ requires awareness in the attribute-searching routines to search
+ without the namespace unless one is specified, and to reserve :: in
+ attribute names unless they're quoted.
+
* alias objects. this is an object handle in a geometry database that
refers to another geometry database object. in effect, it
encapsulates the idea of a symbolic reference for database objects.
@@ -1468,6 +1402,7 @@
* see additional TODO items in file './src/other/step/README'
+
BREP/NURBS
----------
@@ -1656,28 +1591,28 @@
CMAKE
-----
+* ensure successful build on mingw
+
+* update the msvc build to not use installTree.tcl -- the build
+ shouldn't really be reliant upon tclsh or be all contained within
+ the tclsh project. sub-projects should build and install by
+ themselves (e.g. tkhtml3 should generate its htmltokens.h file).
+ the "brlcad" project, if any, can build up the installation tree and
+ generate the final installation exe.
+
+* the binary windows installer is missing headers for our external
+ dependencies (Tcl, zlib, and OpenNURBS in particular as the likes of
+ bu.h and raytrace.h requires them)
+
* remove all of the MSVC sections in the CMakeLists.txt files.
perform proper library/function/flag tests where necessary.
-* write/update INSTALL with ALL cmake options documented (make sure
- there are equivalent cmake options for all configure options or
- document the ones not included (e.g., proe options))
-
- -- Have the majority of these auto-generated and included, need to
- review and see what's still missing.
-
* ensure primary cmake option parity with summary option listing
-- Um. Not sure this is fully achieveable - we only want to
summarize a subset of the src/other settings in the summary
printout, was my (CY) understanding...
-* move cmake documentation files into place
-
- -- Have done so now that the deprecation warning is directing
- users to INSTALL, but will still need to look over old
- INSTALL docs when reviewing option documentation coverage.
-
* investigate ignoring .hidden directories/files from dist packing so
that internal build directories can be used instead of external ones
@@ -1691,6 +1626,7 @@
include/fb.h still ends up entering the IF_X section and declaring a
function that takes a Display and other X11 objects
+
ODDITIES
--------
@@ -1781,6 +1717,7 @@
(desired style to be determined)
+
FUNCTIONALITY NEEDED TO SPEED UP RAYTRACING
-------------------------------------------
@@ -1803,6 +1740,47 @@
DOCUMENTATION
-------------
+* DocBook: create a DB index.xml to generate a doc listing (with
+ hot links) for the html and pdf collection
+
+* DocBook source: add xsl customizations for figure and table title
+ positions, float centering, etc.; add automatic figure, table, and
+ other similar references; add separate markup for html (role='html')
+ and pdf (role='fo') image sizing and placement; remove unnecessary
+ image markup; lift child namespaces to each document's root element.
+
+* group public library headers into subdirs, e.g. include/bu/bu.h, so
+ it's clear when you're using headers from another library and
+ breaking encapsulation.
+
+* make our C headers C++-convenient with proper extern "C" wrapping.
+
+* reorganize the header files in include so it is clear which headers
+ pertain to which libraries.
+
+* improve rtedge documentation, explain how it computes its "centroid"
+ (as it's not exactly the center of bounding box of all objects -- it
+ depends on the booleans).
+
+* break up library headers into subheaders so includes can be more
+ specific (and help speed up compilation) and locally documented.
+
+* write up some documentation on other build tools besides make -
+ CMake supports other generators, wouldn't hurt to detail how to
+ trigger builds in them (MSVC is partially covered, make sure to
+ coverage is complete - others include Eclipse, XCode once we get
+ the kinks ironed out there, CodeBlocks. New experimental ninja
+ build tool and its (also experimental) CMake support are promising -
+ if/when CMake support goes mainstream, document that too.)
+
+* all of the rt* tracers share common code and common options, but do
+ not share common documentation. refactor documentation to use
+ include directives so that there is one place where all of the
+ common options are documented. update usage statements to reflect
+ commonality as well.
+
+* document the saveview/loadview options.
+
* BRL-CAD Overview Diagram
Completed, but not integrated
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
