update devspec.en_US/1.0.general.md.

[devspec.git] / devspec.en_US / 1.1.build-environment.md

\r
\r
\r
# gnu build-tools for gnu soft-pkgs\r
===================================\r
\r
    generally, a GNU soft-pkg uses software below, to build and develop\r
programs.\r
\r
[gnu-soft-pkg]\r
+ Compiler-Linker: gcc/g++/clang/binutils(ld/objcopy/nm/...), libc-dev, \r
  kernel-headers, flex/bison, toolchain-cross-ng(construction of the compiler)\r
+ project orgnize: make/cmake, (meson, ninja)\r
+ compile config soft-pkg: autotools(automake/autoconf/libtool), M4, autogen, \r
  pkg-config, menuconfig\r
\r
+ Multi-language: gettext, libintl\r
+ info/man doc: texinfo, help2man, groff, man, \r
+ code api doc: doxygen, \r
+ webpages: gendocs.sh(script translate texi/docbook doc into html, used for \r
  manual doc on web.)\r
+ tutorial: ttyrec\r
\r
+ code-online-doc:\r
+ design-doc: change-log, ideas-doc, demand-doc, design-doc, \r
  modulize-design-doc, \r
\r
+ debug-utils: gdb/gdb-server, dbglogview, \r
+ testing(unit-test, test-frame work): cunit, cppunit, greg, DejaGnu, \r
+ bug-mngr: bugzilla\r
+ perform: gconv(code-coverage), gprof, perf, systemtap, \r
+ code-chk-utils: lint, Valgrind, \r
\r
+ compile-cache: ccache, \r
+ multi-host-compile: distcc\r
\r
@ code-utils\r
+ code-compare: diff, mesh, beyound-compare\r
+ func-call-trace: cflow(call-graph), global(src-tag-prog)\r
+ code-symbol-tag-index: McCabe/pmccabe/complexity/mifuz, \r
+ code-highlight: Src-highlight, \r
+ code-format: gengen/indent, cproto, \r
+ code-args-autogen: gengetopt, \r
+ code-gen: umbrello\r
\r
@\r
+ code manager: git, RCS/SCCS, diff/patch, \r
+ git+pages: github/gitee/gitlab\r
+ email(cmd-client): mailutils\r
\r
\r
@ other-classical-dev-utilities\r
+ awk, gprof, gperf, dpkg/opkg, \r
+ idutils, OrgaDoc(txt2xml-doc), src-highile, aspell, womb(gnu pkg repo)\r
\r
\r
\r
# pkg-builder\r
=============\r
\r
    pkg-builder is a program set to build soft-pkgs. it's similar with 'make',\r
but it's writen by shell script code, the dependence is only a shell program.\r
    pkg-builder is consisted by those pkgs:\r
\r
@ devspec: pkg of this doc. the guide doc of soft-pkg develop by pkg-builer for\r
  low-level system pkgs, espacially for pkgs of 'skeletone-linux'.\r
@ CCompilerCollection: gcc build src pkgs. it include toolchain-cross-ng, gcc, \r
  binutils, and other dependent pkgs. it can build gcc with different platform.\r
  CCompilerCollection in pkg-builder is a fixed version of gcc. so that \r
  developer uses the same version of compiler, in order to avoid different \r
  compile errors. pkg-builder is face to low-level system pkgs, so it does not\r
  need a frequently updated compiler for many new features.\r
@ build-pkg: equal to 'make'. but the config info is distributed in different\r
  config files. it's easy to dispatch infos in program. it's easy to use, but\r
  it's not smart enough like 'makefile'.\r
@ build-config: the program manuconfig in kernel. let it to be a independence\r
  soft-pkg. so that many other programs can use it for configuration.\r
@ build-pkglist: it's familar with 'buildroot'. it orgnize a system by config\r
  files, and download, config, build it. it support distribute building.\r
@ shlib-devutils: a toolset writen by shell script code. it provide various \r
  programs for developing.\r
@ build-ext-utils: gnu soft-pkg for pkg-builder. some of the feature have not\r
  implemented in pkg-builder. use binary soft-pkg. such as doxygen.\r
@ code-mngr: a version control program like svn/git. it's also a shell script\r
  program. and it need less server-end program to use, it is based on sftp\r
  storage. beyound version control, it support web page update to sftp/git\r
  server.\r
@ soft-repo: published file manage program. src-pkg or binary-pkg, or resource-\r
  pkg. it like a application store, or a program repo for user to download.\r
\r
@ build-res: it provide extend develop resource. the first design goal for pkg-\r
  builder is used for 'skeletone-linux' build and dev, beyound this, it put \r
  other res in build-res to extend using range of it. eg: application develop.\r
\r
@ *dev-assistant: \r
\r
\r
\r
# gnu pkgs beyound pkg-builder\r
==============================\r
\r
    many features has not been implemented in pkg-builder. it uses traditional\r
binary soft-pkgs.\r
\r
@ libtool\r
@ pkg-config\r
@ gettext, libintl\r
@ texinfo, help2man, groff, man\r
@ doxygen\r
@ gendocs.sh(integrated in devutils)\r
@ ttyrec\r
@ ccache\r
@ distcc\r
@ git/RCS/SCCS/CSSC\r
@ mailutils: email(cmd-client).\r
@ gconv, gprof, perf, systemtap\r
\r
@ cunit, cppunit\r
@ lint, Valgrind\r
@ \r
# code-compare: diff, diffutils, meld(with gui), beyound-compare\r
# func-call-trace: cflow(call-graph), global(src-tag-prog)\r
# code-symbol-tag-index: McCabe/pmccabe/complexity/mifuz, \r
# code-highlight: Src-highlight, \r
# code-format: gengen/indent, cproto, \r
# code-args-autogen: gengetopt, \r
\r
@ idutils, OrgaDoc(txt2xml-doc), src-highile, aspell, womb(gnu pkg repo)\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
[gnu¿ª·¢ÖеŤ¾ßÈí¼þ¼¯ºÏ]\r
@ ¿ªÔ´Èí¼þ¿ª·¢Ì×¼þ¹¦ÄÜ\r
# pub(git+pages): github/gitlab/gitee\r
# email(cmd-client): mailutils\r
\r
# ±àÒëÁ´½Ó: gcc/g++/clang/binutil(gcc/g++/ld), libc-dev, kernel-headers, flex/bison, \r
# ¹¤³Ì¹¹½¨, µ÷ÓñàÒëÆ÷±àÒë³ÌÐò: make/cmake, (meson, ninja)\r
# ÅäÖñàÒëÏà¹ØÄÚÈÝ: autotools(automake, autoconf, libtool), autogen, pkg-config, M4, menuconfig\r
# multi-language: gettext, intl\r
# info/manÎĵµÉú³É: texinfo, help2man, Éú³ÉinfoºÍmanµÄ°ïÖúÎĵµ¡£groff¡£\r
# ´úÂëapiÎĵµ: doxygen, ¸ù¾Ý´úÂë, Êä³ö´úÂëµÄapiÎĵµ¡£\r
# ¸ù¾ÝtxtʹÓÃ˵Ã÷Îĵµ, gendocs.sh (script)´¦ÀíºóÊä³öhtmlÎĵµ¡£\r
# code online readÎĵµ, \r
# pkgÖÆ×÷Èí¼þ: dpkg/opkg, \r
\r
# tutorial: ttyrec, \r
+# design-doc(change-log, ideas-doc, demand-doc, design-doc, modulize-doc): \r
# °æ±¾¹ÜÀí: git, RCS/CSSC, diff/patch, \r
\r
# bug-mngr: GNATS, bugzilla\r
# testing(unit-testing, test-framework): cunit, cppunit, greg, DejaGnu, testdrive\r
# degug-utils: gdb/gdbserver, logview\r
# perform: gcov(code-coverage), gprof, perf, systemtap\r
*# code-check-utils: lint, Valgrind, \r
\r
# code-utils: \r
beyoundcompare: \r
inc-file-list: (makefileÖÐ-include $(OBJ:.o,.d), ±àÒë.oÎļþ֮ǰgcc -MM -MT $@ -MF $(patsubst $<,%.o,%.d) $<, Êä³öµ½.dÎļþ-includeµ½makefile, .hÐÞ¸Äʱ, .o³ÌÐò±àÒë¡£)(gcc -MM -MF xxx.d -MT xxx.o xxx.c)\r
func-call-trace: cflow, global, graphvize\r
symbol-tag-index(code-hint): global(src-tag-prog)/McCabe/pmccabe/complexity, \r
code-highlight, Src-Highlite, \r
code-formatter: gengen/indent, cproto, \r
code-arg-autogen: gengetopt\r
code-gen: \r
\r
@ traditional-dev-utilities\r
# gawk, gprof(ÔËÐÐÐÔÄÜÈí¼þ), gperf, \r
# , Idutils, OrgaDoc(txt2xml-doc), Src-Highlite, aspell, womb(gnu pkg repo), \r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
\r
[gnu-dev-tools¿ª·¢Èí¼þ°ü-¹¦ÄܲÙ×÷½Ó¿Ú]\r
@ toolchain &utils\r
\r
@ Èí¼þÅäÖᢱàÒë(dep-chk)¡¢pkgÖÆ×÷¡¢°²×°\r
\r
@ proj(src-dir-scan¡¢file-add/del¡¢param-cfg-file¡¢target-add/del¡¢lib/.h-inc&path¡¢)\r
\r
@ cross±àÒë\r
@ cache¡¢distcc\r
@ doc(man¡¢info¡¢html-pages¡¢doxygen¡¢online-codeview¡¢ttyrec¡¢graphvize¡¢)\r
@ code(format¡¢gen¡¢edit¡¢syn2design)\r
\r
@ src(back¡¢release¡¢version-id¡¢git/RCS¡¢branch¡¢diff/patch¡¢merge¡¢change log)\r
\r
@ pkg(inst-pkg¡¢src-pkg¡¢pkg-repo)\r
\r
\r
@ code-check(mem-leakage¡¢grammar)\r
@ dev(info¡¢str-modify¡¢multi-byte¡¢libintl/gettext¡¢func-trace-graph¡¢hint¡¢hilight¡¢optgen¡¢debug¡¢logview)\r
@ multi-plat-adept(cpu-plat¡¢sys-plat)\r
@ ÐÔÄÜ(performence¡¢gcov)\r
@ test(unit¡¢script)\r
@ bug-mngr\r
@ software(readme¡¢lisence¡¢change log¡¢todo¡¢demand/funclist/idea-record¡¢)\r
@ web-pages(online-wiki/manual/api/code¡¢src/pkg/doc-download¡¢git)\r
\r
@ net-utils(wget/curl¡¢term&ssh-client¡¢mail-utils¡¢)\r