summaryrefslogtreecommitdiff
path: root/pkgtools
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2007-11-28 11:34:20 +0000
committerrillig <rillig@pkgsrc.org>2007-11-28 11:34:20 +0000
commit532c6fad52b327eb42c629ec267b432b307ffcc5 (patch)
treed344a57b3409b35f3237bbf245aa8d0493a3aac3 /pkgtools
parent2a1ed84efbbd0c3392947f509147a70679c4c5fa (diff)
downloadpkgsrc-532c6fad52b327eb42c629ec267b432b307ffcc5.tar.gz
Added some comments that explain the data structures.
Diffstat (limited to 'pkgtools')
-rw-r--r--pkgtools/pbulk/files/pbulk/pbuild/jobs.c8
-rw-r--r--pkgtools/pbulk/files/pbulk/pbuild/pbuild.h39
2 files changed, 45 insertions, 2 deletions
diff --git a/pkgtools/pbulk/files/pbulk/pbuild/jobs.c b/pkgtools/pbulk/files/pbulk/pbuild/jobs.c
index 07194da2576..afb02aceec2 100644
--- a/pkgtools/pbulk/files/pbulk/pbuild/jobs.c
+++ b/pkgtools/pbulk/files/pbulk/pbuild/jobs.c
@@ -1,4 +1,4 @@
-/* $NetBSD: jobs.c,v 1.5 2007/08/15 20:55:28 joerg Exp $ */
+/* $NetBSD: jobs.c,v 1.6 2007/11/28 11:34:20 rillig Exp $ */
/*-
* Copyright (c) 2007 Joerg Sonnenberger <joerg@NetBSD.org>.
@@ -391,6 +391,12 @@ recursive_mark_broken(struct build_job *job, enum job_state state)
}
}
+/**
+ * Changes the state of the ''job'' to ''state'' and runs some code
+ * depending on the new state. If ''log_state'' is non-zero, the package
+ * name is written to either the "error" or the "success" log, depending
+ * on the ''state''.
+ */
void
process_job(struct build_job *job, enum job_state state, int log_state)
{
diff --git a/pkgtools/pbulk/files/pbulk/pbuild/pbuild.h b/pkgtools/pbulk/files/pbulk/pbuild/pbuild.h
index 8e10578f507..1bcd7bc804a 100644
--- a/pkgtools/pbulk/files/pbulk/pbuild/pbuild.h
+++ b/pkgtools/pbulk/files/pbulk/pbuild/pbuild.h
@@ -1,4 +1,4 @@
-/* $NetBSD: pbuild.h,v 1.3 2007/07/21 15:44:02 tnn Exp $ */
+/* $NetBSD: pbuild.h,v 1.4 2007/11/28 11:34:20 rillig Exp $ */
/*-
* Copyright (c) 2007 Joerg Sonnenberger <joerg@NetBSD.org>.
@@ -36,6 +36,21 @@
#include <inttypes.h>
#endif
+/**
+ * At the very beginning of a pbulk, each job is in state JOB_INIT.
+ *
+ * (jobs.c, init_jobs:) If scanning the package failed or the package is
+ * not available for this configuration, its state is changed to
+ * JOB_PREFAILED. Packages that are listed in the "error" log are marked
+ * as JOB_FAILED, those in the the "success" log are marked as JOB_DONE.
+ * The remaining jobs are marked as JOB_OPEN.
+ *
+ * The packages that are ready to be built are those that have the state
+ * JOB_OPEN and no pending dependencies. At most one job can be in the
+ * state JOB_IN_PROCESSING. After trying to build a job, its state is
+ * set to either JOB_DONE or to JOB_FAILED. In the latter case, all the
+ * jobs that depend on this one are marked as JOB_INDIRECT_FAILED.
+ */
enum job_state {
JOB_INIT,
JOB_OPEN,
@@ -65,14 +80,36 @@ struct dependency_list {
};
struct build_job {
+ /** The package name, including the version number. */
char *pkgname;
+
+ /**
+ * Pointers into the output from pbulk-resolve. The lines
+ * between these two pointers describe additional properties
+ * of the job, such as the PKGPATH in which to build the
+ * package. The information can be accessed with the
+ * find_content function.
+ */
const char *begin;
const char *end;
+
enum job_state state;
int pkg_depth;
+
+ /**
+ * Iff this is 1, this package and all its dependencies do not
+ * have any definition for RESTRICTED or NO_BIN_ON_FTP, and thus
+ * may be uploaded on a public FTP server.
+ */
int unrestricted_subset;
+
+ /**
+ * The number of direct dependencies that must be built before
+ * this package can be tried.
+ */
size_t open_depends;
+ /** The packages that depend on this package. */
SLIST_HEAD(, dependency_list) depending_pkgs;
TAILQ_ENTRY(build_job) build_link;