You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@gump.apache.org by aj...@apache.org on 2004/03/24 16:51:42 UTC
cvs commit: gump/template/forrest/src/documentation/content/xdocs site.xml
ajack 2004/03/24 07:51:42
Modified: python/gump/document forrest.py
template/forrest/src/documentation/content/xdocs site.xml
Log:
Generate a 'notes log', a page showing the annotations on modules/project, IFF the module/project has 'nasties' (warnings/errors).
There are numerous notes being made on projects, and I doubt many are being reviewed...
Revision Changes Path
1.115 +50 -5 gump/python/gump/document/forrest.py
Index: forrest.py
===================================================================
RCS file: /home/cvs/gump/python/gump/document/forrest.py,v
retrieving revision 1.114
retrieving revision 1.115
diff -u -r1.114 -r1.115
--- forrest.py 24 Mar 2004 15:19:22 -0000 1.114
+++ forrest.py 24 Mar 2004 15:51:42 -0000 1.115
@@ -473,6 +473,51 @@
if not pcount: projectsTable.createLine('None')
document.serialize()
+
+ #
+ # ----------------------------------------------------------------------
+ #
+ # notesLog.xml -- Notes log
+ #
+ document=XDocDocument('Annotations', \
+ self.resolver.getFile(workspace,'notesLog'))
+ self.documentSummary(document, workspace.getProjectSummary())
+
+ notesSection=document.createSection('Negative Annotations')
+ notesSection.createParagraph(
+ """Entities with errors and warnings.""")
+
+ ncount=0
+ for module in gumpSet.getModuleSequence():
+ if not gumpSet.inModuleSequence(module): continue
+
+ moduleSection=document.createSection('Module : ' + module.getName())
+
+ # Link to the module
+ self.insertLink(module,workspace,moduleSection.createParagraph())
+
+ if not module.containsNasties():
+
+ # Display the annotations
+ self.documentAnnotations(moduleSection,project,1)
+
+ for project in module.getProjects():
+ if not gumpSet.inProjectSequence(project): continue
+ if not project.containsNasties(): continue
+
+ projectSection=moduleSection.createSection('Project : ' + project.getName())
+
+ # Link to the project
+ self.insertLink(project,workspace,projectSection.createParagraph())
+
+ # Display the annotations
+ self.documentAnnotations(projectSection,project,1)
+
+ ncount+=1
+
+ if not ncount: notesTable.createLine('None')
+
+ document.serialize()
#
# ----------------------------------------------------------------------
@@ -1540,14 +1585,14 @@
return totalDeps
- def documentAnnotations(self,xdocNode,annotatable):
+ def documentAnnotations(self,xdocNode,annotatable,noWarn=0):
annotations=annotatable.getAnnotations()
if not annotations: return
annotationsSection=xdocNode.createSection('Annotations')
- if annotatable.containsNasties():
+ if annotatable.containsNasties() and not noWarn:
annotationsSection.createWarning( \
'Some warnings and/or errors are present within these annotations.')
1.22 +1 -0 gump/template/forrest/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/gump/template/forrest/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- site.xml 12 Mar 2004 16:10:39 -0000 1.21
+++ site.xml 24 Mar 2004 15:51:42 -0000 1.22
@@ -11,6 +11,7 @@
<work label="Gump">
<index label="Workspace" href="index.html"/>
<index label="Build Log" href="buildLog.html"/>
+ <index label="Notes Log" href="notesLog.html"/>
</work>
<work label="Projects" tab="home">
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@gump.apache.org
For additional commands, e-mail: general-help@gump.apache.org