diff --git a/docs/book/architecture.txt b/docs/book/architecture.txt index 0973e8ca..1a9306e6 100644 --- a/docs/book/architecture.txt +++ b/docs/book/architecture.txt @@ -50,7 +50,7 @@ class somename(Context): fun = 'foo' --------------- -image::classes{PIC}["Context classes"{backend@docbook:,width=1000:},align="center"] +image::classes{PIC}["Context classes"{backend@docbook:,width=850:},align="center"] ==== Build classes @@ -62,7 +62,7 @@ The 'Parallel' object encapsulates the iteration over all tasks of the build con The overall structure is represented on the following diagram: -image::classes_build{PIC}["Build classes"{backend@docbook:,width=1000:},align="center"] +image::classes_build{PIC}["Build classes"{backend@docbook:,width=1100:},align="center"] === Context objects diff --git a/docs/book/classes_build.dia b/docs/book/classes_build.dia deleted file mode 100644 index c444ad95..00000000 --- a/docs/book/classes_build.dia +++ /dev/null @@ -1,4058 +0,0 @@ - - - - - - - - - - - - - #A4# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #BuildContext# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #groups# - - - #task_gen# - - - ## - - - ## - - - - - - - - - - - - - - #env# - - - #ConfigSet# - - - ## - - - ## - - - - - - - - - - - - - - - - #store# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - #filename# - - - ## - - - ## - - - ## - - - - - - - - - - #load# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - #filename# - - - ## - - - ## - - - ## - - - - - - - - - - #install_files# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #install_as# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #symlink_as# - - - ## - - - ## - - - - - - ## - - - - - - - - - - - - - - - - - - #init_dirs# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #get_tgen_by_name# - - - ## - - - #task_gen# - - - - - - ## - - - - - - - - - - - - - - - - - #name# - - - #string# - - - ## - - - ## - - - - - - - - - - #add_group# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #ConfigSet# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #parent# - - - #Environment# - - - ## - - - ## - - - - - - - - - - - - - - #table# - - - #dict# - - - ## - - - ## - - - - - - - - - - - - - - - - #derive# - - - ## - - - #Environment# - - - - - - ## - - - - - - - - - - - - - - - - - - #store# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - #filename# - - - ## - - - ## - - - ## - - - - - - - - - - #load# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #append_value# - - - ## - - - ## - - - - - - ## - - - - - - - - - - - - - - - - - #var# - - - #string# - - - ## - - - ## - - - - - - - - #val# - - - #string# - - - ## - - - ## - - - - - - - - - - #append_unique# - - - ## - - - ## - - - - - - ## - - - - - - - - - - - - - - - - - #var# - - - #string# - - - ## - - - ## - - - - - - - - #val# - - - #string# - - - ## - - - ## - - - - - - - - - - #prepend_value# - - - ## - - - ## - - - - - - ## - - - - - - - - - - - - - - - - - #var# - - - #string# - - - ## - - - ## - - - - - - - - #val# - - - #string# - - - ## - - - ## - - - - - - - - - - #__getitem__# - - - ## - - - #object# - - - - - - ## - - - - - - - - - - - - - - - - - #variable# - - - ## - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #task_gen# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #tasks# - - - #TaskBase# - - - ## - - - ## - - - - - - - - - - - - - - - - #get_name# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #post# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #apply# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #create_task# - - - ## - - - #TaskBase# - - - - - - ## - - - - - - - - - - - - - - - - - #name# - - - #string# - - - ## - - - ## - - - - - - - - - - #clone# - - - ## - - - #task_gen# - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Parallel# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #bld# - - - #BuildContext# - - - ## - - - ## - - - - - - - - - - - - - - #numjobs# - - - #int# - - - ## - - - ## - - - - - - - - - - - - - - #maxjobs# - - - #int# - - - ## - - - ## - - - - - - - - - - - - - - #processed# - - - #int# - - - ## - - - ## - - - - - - - - - - - - - - #total# - - - #int# - - - ## - - - ## - - - - - - - - - - - - - - #count# - - - #int# - - - ## - - - ## - - - - - - - - - - - - - - #outstanding# - - - #List<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - #frozen# - - - #List<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - #out# - - - #Queue<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - #error# - - - #List<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - #stop# - - - #boolean# - - - ## - - - ## - - - - - - - - - - - - - - #biter# - - - #PyGenerator<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - - - #postpone# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - #TaskBase# - - - ## - - - ## - - - ## - - - - - - - - - - #get_next_task# - - - ## - - - #TaskBase# - - - - - - ## - - - - - - - - - - - - - - - - - - #refill_task_list# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #start# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #error_handler# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - #task# - - - #TaskBase# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #TaskConsumer# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #pool# - - - #List<TaskConsumer># - - - ## - - - ## - - - - - - - - - - - - - - #ready# - - - #Queue<Task># - - - ## - - - ## - - - - - - - - - - - - - - - - #run# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #TaskBase# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #classes (static)# - - - #class# - - - ## - - - ## - - - - - - - - - - - - - - - - #run# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #runnable_status# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #post_run# - - - ## - - - #void# - - - - - - ## - - - - - - - - - - - - - - - - - - #unique_id# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Task# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #inputs# - - - #Node# - - - ## - - - ## - - - - - - - - - - - - - - #outputs# - - - #Node# - - - ## - - - ## - - - - - - - - - - - - - - #run_after# - - - #list<TaskBase># - - - ## - - - ## - - - - - - - - - - - - - - - - #unique_id# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #signature# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #sign_explicit_deps# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #sign_implicit_deps# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - #sign_vars# - - - ## - - - #int# - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #store_task_type# - - - #metaclass# - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #use# - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #use# - - - ## - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - #Node# - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #name# - - - #string# - - - ## - - - ## - - - - - - - - - - - - - - #parent# - - - #Node# - - - ## - - - ## - - - - - - - - - - - - - - #sig# - - - #long# - - - ## - - - ## - - - - - - - - - - - - - - #children# - - - #dict<string, Node># - - - ## - - - ## - - - - - - - - - - - - - - #cache_abspath# - - - #string# - - - ## - - - ## - - - - - - - - - - - - - - #cache_isdir# - - - #boolean# - - - ## - - - ## - - - - - - - - - - - - - - - - #abspath# - - - ## - - - #string# - - - - - - ## - - - - - - - - - - - - - - - - - - #find_dir# - - - ## - - - #Node# - - - - - - ## - - - - - - - - - - - - - - - - - #path# - - - ## - - - ## - - - ## - - - - - - - - - - #find_resource# - - - ## - - - #Node# - - - - - - ## - - - - - - - - - - - - - - - - - #path# - - - ## - - - ## - - - ## - - - - - - - - - - #find_or_declare# - - - ## - - - #Node# - - - - - - ## - - - - - - - - - - - - - - - - - #path# - - - ## - - - ## - - - ## - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #children# - - - #0..n# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #parent# - - - #0..1# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - #outputs# - - - #0..n# - - - - - - - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - #inputs# - - - #0..n# - - - - - - - - - ## - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #tasks# - - - #0..n# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #groups# - - - #0..n# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #env# - - - #1# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #env# - - - #1# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## - - - - - - - - - - - - ## - - - ## - - - - - - - - - #env# - - - #1# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/book/classes_build.semd b/docs/book/classes_build.semd new file mode 100644 index 00000000..45e9f47b Binary files /dev/null and b/docs/book/classes_build.semd differ diff --git a/docs/book/tasks.txt b/docs/book/tasks.txt index 5f62fe7b..a50be86a 100644 --- a/docs/book/tasks.txt +++ b/docs/book/tasks.txt @@ -9,7 +9,7 @@ This chapter provides a description of the task classes which are used during th The build context is only used to create the tasks and to return lists of tasks that may be executed in parallel. The scheduling is delegated to a task producer which lets task consumers to execute the tasks. The task producer keeps a record of the build state such as the amount of tasks processed or the errors. -image::tasks_actors{PIC}["Actors processing the tasks"{backend@docbook:,width=150:},align="center"] +image::tasks_actors{PIC}["Actors processing the tasks"{backend@docbook:,width=250:},align="center"] // To reduce the build time, it is interesting to take advantage of the hardware (multiple cpu cores) or of the environment (distributed builds). The amount of consumers is determined from the number of processors, or may be set manually by using the '-j' option: diff --git a/docs/book/tasks_actors.dia b/docs/book/tasks_actors.dia deleted file mode 100644 index 4d2efa4a..00000000 --- a/docs/book/tasks_actors.dia +++ /dev/null @@ -1,533 +0,0 @@ - - - - - - - - - - - - - #A4# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #BuildContext# - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Task Producer# - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Task consumer# - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Process a task# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Get tasks to process# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Task consumer n# - - - - - - - - - - - - - - - - - - - - ## - - - ## - - - - - ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Process a task# - - - - - - - - - - - - - - diff --git a/docs/book/tasks_actors.semd b/docs/book/tasks_actors.semd new file mode 100644 index 00000000..3c0437db Binary files /dev/null and b/docs/book/tasks_actors.semd differ