first version.

[build-srcpkg.git] / doc / todolist.txt

[ideas]
@ feature-str-id for src-pkg build
# beyound code in codelib dir, it include a README.md, build param file, 
  testing info files, performence info file, lisence file, feature-id-str file.
# feature str, name & domain of feature. code in a src pkg is not putted in
  domain string path, it's just under the dir of 'codelib'.
# feature id is a sha value with feature name and README.md
# feature id also contains sha value with feature name, RREADME.md, and src
  files. this id is used for corresponding version matching.
# featurelist.lst, it's a file provided for other pkg reference code in codelib
  of current src-pkg. compare with .pc file, this file can matching feature
  in module. some feature are existing in a lib, but it also can be referenced
  in other package not only by linking. eg: a short piece of code in gnulib 
  should be referenced in other src-pkg, but it's too complex to link a gnulib
  lib file to the program, so copy code to current src-pkg is a good idea to
  solve this problem. 
  + it keeps src code synchronizing with orignial src-pkg, this avoid multiple 
    version of code by copying code.
  + it decrease external lib dependence.
  + it provide the connection between feature and src-pkg.



#############################################################################
#############################################################################


[tagdoc]

@ tagdocÖеÄdoc£¬ÈçÊǹ¦ÄÜÌØÐÔÐèÇó£¬×ª»¯Îª¹¦ÄÜÌØÐÔÎÄ×ÖÃèÊö£¬²¢½«¹¦ÄÜÌØÐÔµÄtag·Åµ½docµÄ¹ØÁªfollowed-tagÖУ¬docµÄtag·Åµ½¹¦ÄÜÌØÐÔÎÄ×ÖÃèÊöµÄprev-tagÖС£
# ¹¦ÄÜÌØÐԺ͹¦ÄÜÄ£¿éÖ®¼äÒ²ÒÔtag¹ØÁª¡£
# ÔÚ¹¦ÄÜÄ£¿éä¯ÀÀʱ£¬¿É¿´µ½prev-tagµÄÄÚÈÝ£¬Ò»Ð©¹¦ÄÜÄ£¿éÐÞ¸Äʱ£¬ÆäËüdoc¿É¸üС£
# Ò»¸ö¼Ç¼´ÓÒ»¸ösrc-pkg£¬×ªµ½sub-src-pkgʱ£¬¼Ç¼come-fromÐÅÏ¢£¬±íʾ¹¦ÄÜÌØÐÔ»òÐèÇóÔ´×ÔÓÚÄĸöpkg¡£
# Ò»¸ö¼Ç¼ÖеÄÄÚÈÝ£¬È¡Ò»²¿·Ö£¬³ÉÁíÒ»¸ösub-record¡£ÔÚÔ­ÓмǼÖÐÌí¼Óbranch-tag£¬ÔÚsub-recordÖУ¬Ìí¼Ósrc-tag£¬±íʾһ¸ö¹¦ÄÜÌØÐÔ»òÐèÇóÃèÊöµÄÑÝ»¯¡£ÒòΪһ¸ö¼Ç¼ÖУ¬¿ÉÄÜ°üº¬¶à¸ö¹¦ÄÜÌØÐÔµÄÃèÊö¡£ÔÚsub-recordÖУ¬¿É¿´µ½src-tagÖÐÆäËüÏà½üºÍÏà¹ØµÄÄÚÈÝ£¬Êä³öΪsee also¡£
@ tagdocÖеÄÎÄ×Ö£¬ÒÔitemΪµ¥Î»£¬diff gitÉϵÄÄÚÈÝ£¬½«Ôö¼ÓµÄitemµ¥ÁÐÒ»¸ötagdocÎļþ£¬ÓÃÓÚÈ˹¤Ìí¼Ó¡£
# ÎļþÌå»ý±È½ÏÅÓ´óʱ£¬¸ù¾ÝtagºÍĿ¼£¬»®·ÖΪ¶à¸öÎļþ»òĿ¼¡£

[ **build-pkg** ]

#############################################################################
#############################################################################

[todolist]
@ modify doc dir, and update pkg design info.

=================================================

¡¾build-pkg¡¿

@ build-pkg
# util pkg compile
# path & cfgdirs(pkg-install)£¬
# builders(flist£¬plist£¬tag£¬gen-proclib£¬proclib)
# build-pkg(subcmd/taglib£¬toolchain-mngr£¬taskunit)
# build param£¬²Î¿¼projectÖеIJÎÊý
# build-opr-lib
# tag-mngr
# param-lib
# cross-compile£¬build with param pfx
# build example£ºlibcxt

@ *soft-mngr(
# pkg/prog/lib/res mngr
# app/soft/midware/bsp/drv mngr
# soft-center/soft-repository

¡¾note¡¿
ref: 1.design/2.pkg-builder/build-pkg/ideas.txt


@ build-pkg
# build: ÓÃÓÚcompile£¬build£¬pkg£¬install£¬testµÈÓû§²Ù×÷¡£
# dev£ºÓÃÓÚprojÏà¹Ø²Ù×÷£¬task²Ù×÷µÈ£¬ÓÃÓÚdeveloper¡£
  + dev exthdrlist£ºÊä³ösrcÒÀÀµµÄsrc hdr£¬½«src pkgÖеÄhdr¹ýÂË£¬ÍⲿhdrÒÀÀµ±£´æ
    µ½Îļþ£¬ÔÚbuildʱ½øÐÐincÎļþchkʱʹÓá£
  + dev extliblist£ºÊä³ösrcpkgÖÐʹÓõÄlib£¬ÓÃÓÚbuildʱµÄchk¡£

@ subcmd, arch-list, srcpkg-list, dest-list, dest-type, dest-type-step, 
  build-dep,

@ build-pkg
# util pkg compile
# path & cfgdirs(pkg-install)£¬
# builders(flist£¬plist£¬tag£¬gen-proclib£¬proclib)
# build-pkg(subcmd/taglib£¬toolchain-mngr£¬taskunit)
# build param£¬²Î¿¼projectÖеIJÎÊý
# build-opr-lib
# tag-mngr
# param-lib
# cross-compile£¬build with param pfx
# build example£ºlibcxt












@ build
!# src-list, paramters, multi dest/instpkg/arch ...
!# compile script code.
!# build/dev/devtask cmd opt-define, and it's diagram.
# ADFD diagram accroding compile script code.
@ absolution
# param-list.
        + <lang>-src-list, 
        + macro-def-list,  
        + inc-path-list,  
        + lib-path-list,  
        + inc-lib-list, 
        + misc-param, 
        + single-file-paramter, 
        + developer-info-paramter, 
        + soft-pkg-info-paramter, 
        + output: CFLAGS/CPPFLAGS/LDFLAGS
        + format: CFLAGS_FMT ... some paramter should be in particular sequence.
        + param_gen("NAME_STR"), generate paramter.
        + cmd_str_gen().
# utility prog.
        + pkg-conf/diff/patch/intltool/texinfo/gettext-tiny/ttyrec/
# toolchain.
        + <src>2<dst>() functions.
        + program set. as/gcc/g++(c++/cpp)/ld/ranlib/ar/nm/objcopy/objdump/strip/
          gcov/gprof, flex/bison/libtool, elfedit/readelf/addr2line/string/size.
# build dest
        + sub-srcpkg-list, 
        + buildtime-dep-list, 
        + runtime-dep-list, 
        + instpkg-list, 
        + dest-list, 
        + build_srcpkg("path")/unarchive_srcpkg()/download_srcpkg("name")
        + build_dest("name")/build_instpkg("name")/build_target("name")
# taskunit.
        + short-time-one-cmd-task (one mainly cmd, and repeated several times with
          input paramter), eg: compile/link a src file
        + long-time-task, eg: build a pkg.
        + deamon-task/svc, eg: network-service.
        + (input/output/waitlist/deptp) 
        + (wants/after/trig/before/conflicts/wantedby/requisite/requires)