Commit 4e9582c3 authored by Wayne Stambaugh's avatar Wayne Stambaugh

Add road map to developer's documentation.

- Create KiCad road map document.
- Add road map to developer's documentation.
- A separate road map build command to CMake so the road map can be built
  separately for use in websites.
- Update .bzrignore to ignore road map files generated by Doxygen.
parent c97afea4
...@@ -28,6 +28,7 @@ version.h ...@@ -28,6 +28,7 @@ version.h
config.h config.h
install_manifest.txt install_manifest.txt
Documentation/doxygen Documentation/doxygen
Documentation/development/doxygen
*.bak *.bak
common/pcb_plot_params_keywords.cpp common/pcb_plot_params_keywords.cpp
include/pcb_plot_params_lexer.h include/pcb_plot_params_lexer.h
......
...@@ -687,6 +687,13 @@ if( DOXYGEN_FOUND ) ...@@ -687,6 +687,13 @@ if( DOXYGEN_FOUND )
DEPENDS Doxyfile DEPENDS Doxyfile
COMMENT "building doxygen docs into directory Documentation/doxygen/html" COMMENT "building doxygen docs into directory Documentation/doxygen/html"
) )
add_custom_target( dev-docs
${CMAKE_COMMAND} -E remove_directory Documentation/development/doxygen
COMMAND ${DOXYGEN_EXECUTABLE}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/Documentation/development
DEPENDS Doxyfile
COMMENT "building developer's resource docs into directory Documentation/development/doxygen/html"
)
else() else()
message( STATUS "WARNING: Doxygen not found - doxygen-docs (Source Docs) target not created" ) message( STATUS "WARNING: Doxygen not found - doxygen-docs (Source Docs) target not created" )
endif() endif()
......
This diff is collapsed.
This diff is collapsed.
...@@ -338,7 +338,7 @@ TYPEDEF_HIDES_STRUCT = NO ...@@ -338,7 +338,7 @@ TYPEDEF_HIDES_STRUCT = NO
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols. # corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0 SYMBOL_CACHE_SIZE = 4
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
...@@ -349,7 +349,7 @@ SYMBOL_CACHE_SIZE = 0 ...@@ -349,7 +349,7 @@ SYMBOL_CACHE_SIZE = 0
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols. # corresponding to a cache size of 2^16 = 65536 symbols.
LOOKUP_CACHE_SIZE = 0 LOOKUP_CACHE_SIZE = 6
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Build related configuration options # Build related configuration options
...@@ -661,7 +661,8 @@ WARN_LOGFILE = ...@@ -661,7 +661,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = kicad \ INPUT = Documentation/development/road-map.md \
kicad \
pcbnew \ pcbnew \
cvpcb \ cvpcb \
eeschema \ eeschema \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment