From James.Gates@sun.com Fri Sep 26 10:12:50 2008 Received: from newsunmail1brm.central.sun.com (newsunmail1brm.Central.Sun.COM [129.147.62.245]) by sac.sfbay.sun.com (8.13.8+Sun/8.13.8) with ESMTP id m8QHCouT009761 for ; Fri, 26 Sep 2008 10:12:50 -0700 (PDT) Received: from nwk-avmta-1.SFBay.Sun.COM (nwk-avmta-1.SFBay.Sun.COM [129.146.11.74]) by newsunmail1brm.central.sun.com (8.13.7+Sun/8.13.7/ENSMAIL,v2.2) with ESMTP id m8QHCmFY026412 for <@sunmail2sca.sfbay.sun.com:lsarc-ext@sun.com>; Fri, 26 Sep 2008 11:12:49 -0600 (MDT) Received: from pmxchannel-daemon.nwk-avmta-1.sfbay.Sun.COM by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) id <0K7T00I0FBTD9X00@nwk-avmta-1.sfbay.Sun.COM> for lsarc-ext@sun.com (ORCPT lsarc-ext@sun.com); Fri, 26 Sep 2008 10:12:49 -0700 (PDT) Received: from gmp-eb-inf-2.sun.com ([192.18.6.24]) by nwk-avmta-1.sfbay.Sun.COM (Sun Java System Messaging Server 6.2-3.04 (built Jul 15 2005)) with ESMTP id <0K7T00CYWBTCLH50@nwk-avmta-1.sfbay.Sun.COM> for lsarc-ext@sun.com (ORCPT lsarc-ext@sun.com); Fri, 26 Sep 2008 10:12:49 -0700 (PDT) Received: from fe-emea-09.sun.com (gmp-eb-lb-1-fe3.eu.sun.com [192.18.6.10]) by gmp-eb-inf-2.sun.com (8.13.7+Sun/8.12.9) with ESMTP id m8QHClGm015056 for ; Fri, 26 Sep 2008 17:12:47 +0000 (GMT) Received: from conversion-daemon.fe-emea-09.sun.com by fe-emea-09.sun.com (Sun Java System Messaging Server 6.2-8.04 (built Feb 28 2007)) id <0K7T00001BJ6ET00@fe-emea-09.sun.com> (original mail from James.Gates@Sun.COM) for lsarc-ext@sun.com (ORCPT lsarc-ext@sun.com); Fri, 26 Sep 2008 18:12:47 +0100 (BST) Received: from [192.168.1.104] ([129.150.66.234]) by fe-emea-09.sun.com (Sun Java System Messaging Server 6.2-8.04 (built Feb 28 2007)) with ESMTPSA id <0K7T00EZCBSMG740@fe-emea-09.sun.com> for lsarc-ext@sun.com (ORCPT lsarc-ext@sun.com); Fri, 26 Sep 2008 18:12:47 +0100 (BST) Date: Fri, 26 Sep 2008 13:11:35 -0400 From: James Gates Subject: Doxygen: Source Code Documentation Tool [LSARC/2008/612 Self Review] Sender: James.Gates@sun.com To: lsarc-ext@sun.com Cc: Frank Jennings Message-id: <48DD17C7.2050500@sun.com> MIME-version: 1.0 Content-type: multipart/mixed; boundary="Boundary_(ID_SO+7eydRtN5OgdjIP6pvug)" X-PMX-Version: 5.4.1.325704 User-Agent: Thunderbird 2.0.0.16 (X11/20080807) Status: RO Content-Length: 20812 This is a multi-part message in MIME format. --Boundary_(ID_SO+7eydRtN5OgdjIP6pvug) Content-type: text/plain; format=flowed; charset=ISO-8859-1 Content-transfer-encoding: 7BIT I'm sponsoring this case for Frank Jennings. It is closed, automatically approved on account of the FOSS checklist [1] having no questions answered with "ARC review required". The completed FOSS checklist is attached with the onepager and is also located in the case directory. [1] http://sac.sfbay/arc/LSARC/2008/061/proposal.txt -- Jim Gates Sun Microsystems Nashua, NH, USA http://sun.com/postgresql --Boundary_(ID_SO+7eydRtN5OgdjIP6pvug) Content-type: text/plain; name=doxygen_onepager.txt Content-transfer-encoding: 7BIT Content-disposition: inline; filename=doxygen_onepager.txt 1. Introduction 1.1. Project/Component Working Name: Doxygen: Source Code Documentation Tool 1.2. Name of Document Author/Supplier: Frank Jennings (Frank.Jennings@Sun.COM) 1.3. Date of This Document: 09/11/08 1.3.1. Date this project was conceived: 07/31/08 1.4. Name of Major Document Customer(s)/Consumer(s): 1.4.1. The PAC or CPT you expect to review your project: No PAC Approval Yet 1.4.2. The ARC(s) you expect to review your project: LSARC 1.4.3. The Director/VP who is "Sponsoring" this project: Shripad.Patki@Sun.Com 1.4.4. The name of your business unit: Information Products Group 1.5. Email Aliases: 1.5.1. Responsible Manager: Geetha.Nazare@Sun.COM 1.5.2. Responsible Engineer: Frank.Jennings@Sun.COM 1.5.3. Marketing Manager: Geetha.Nazare@Sun.COM 1.5.4. Interest List: ipgpkgteam@sun.com 2. Project Summary 2.1. Project Description: This project proposes to integrate Doxygen v1.5.6, an open source documentation tool for source code written in C, C++, and Java. 2.2. Risks and Assumptions: Doxygen is built with DoxyWizard turned off (--with-doxywizard configure flag off). This is because native QT support is not available. A patch is written to disable Latex generation while building Doxygen since Latex/TeTex is not available. Graphviz - No strict dependency but the build tool looks for Graphviz. Graphviz will be available in NV100. Doxygen targeted for NV101. 3. Business Summary Doxygen will be integrated into Solaris as a standalone package in the SFW consolidation. This will enable Solaris developers/users to generate HTML documentation from doxygen marked source files. In recent days, most of the commercial application code spawns vertical applications that need bits and pieces of its API. These bits-functions, entry points, subroutines, needs to documented through API documentation tools. Doxygen fits this scenario quite well and in fact, Doxygen generated HTML pages are seen in the form of bundled product documentation and online help. 3.1. Problem Area: At present, generating API documentation in Solaris is a priority. Solaris has always been missing a tool for generating source code documentation. By integrating Dxoygen, generating documentation for source code will become easier. 3.2. Market/Requester: Sun internal documentation team. 3.3. Business Justification: At present, technical writers and product documentation specialists do not consider Solaris for building API documentation because of the lack of Doxygen support. Most of the open source software now uses Doxyfiles as the preffered way of documentating APIs, so bundling Doxygen with Solaris becomes a priority. 3.4. Competitive Analysis: NA 3.5. Opportunity Window/Exposure: NA 3.6. How will you know when you are done?: This is a package porting effort. The project is tested on Solaris. Just needs to be integrated. 4. Technical Description: 4.1. Details: Doxygen is aimed at SFW consolidation as part of the package porting efforts and here is the file/layout details: http://cr.opensolaris.org/~frankj/doxygen/ Doxygen installation is straight forward. 4.2. Bug/RFE Number(s): RFE: 6735784 4.3. In Scope: - 4.4. Out of Scope: - 4.5. Interfaces: Exported Interfaces ------------------- NAME STABILITY NOTES /usr/bin/doxygen Uncommitted Executable location /usr/bin/doxytag Uncommitted Executable location /usr/share/man/man1/doxygen.1 Uncommitted Man Page for doxygen command /usr/share/man/man1/doxytag.1 Uncommitted Man Page for doxytag command /usr/share/doc/doxygen-1.5.6/doxygen_manual-1.5.6.pdf Uncommitted Doxygen User Guide (PDF) SUNWdoxygen Committed Doxygen Package 4.6. Doc Impact: Man pages for doxygen and doxytag commands are available under /usr/share/man/man1. Doxygen User Guide is copied to /usr/share/doc/doxygen-1.5.6/doxygen_manual-1.5.6.pdf 4.7. Admin/Config Impact: None 4.8. HA Impact: None 4.9. I18N/L10N Impact: Doxygen is configured to support nl,se,cz,fr,id,it,de,jp,je,es,fi,ru,hr,pl,pt,hu,kr,ke,ro,si,cn,no,br,dk,sk,ua,gr,tw,sr,ca,lt,za,ar and fa. These languages are enabled apart from English. 4.10. Packaging & Delivery: It will be delivered to SFW consolidation. 4.11. Security Impact: None 4.12. Dependencies: None. Only Solaris Core dependecy. 5. Reference Documents: -> RFE - http://monaco.sfbay.sun.com/detail.jsf?cr=6735784 -> OSR - https://opensourcereview.central.sun.com/app?action=ViewReq&traq_num=9692 -> Code Review - http://cr.opensolaris.org/~frankj/doxygen/ -> Product Page - http://www.doxygen.org 6. Resources and Schedule: 6.1. Projected Availability: November 2008 (B101) 6.2. Cost of Effort: None. Just a package porting effort. packages are ready to be integrated. 6.3. Cost of Capital Resources: None. 6.4. Product Approval Committee requested information: 6.4.1. Consolidation or Component Name: SFW Consolidation 6.4.3. Type of CPT Review and Approval expected: FastTrack 6.4.4. Project Boundary Conditions: http://www.doxygen.org 6.4.5. Is this a necessary project for OEM agreements: No 6.4.6. Notes: - 6.4.7. Target RTI Date/Release: NV B101 6.4.8. Target Code Design Review Date: Done. 6.4.9. Update approval addition: - 6.5. ARC review type: FastTrack 6.6. ARC Exposure: Open 6.6.1. Rationale: NA 7. Prototype Availability: 7.1. Prototype Availability: Available 7.2. Prototype Cost: NA --Boundary_(ID_SO+7eydRtN5OgdjIP6pvug) Content-type: text/plain; name=doxygen_foss_checklist.txt Content-transfer-encoding: 7BIT Content-disposition: inline; filename=doxygen_foss_checklist.txt FCL--FOSS Check List 0. Introduction 0.1 Document History Version Author Changes Date 0.1 John Fischer Initial Draft 01/11/2008 0.2 John Fischer Modified based upon feedback from ARC members 01/29/2008 0.3 John Fischer Modified based upon feedback during committee 02/12/2008 review 0.4 John Fischer Modified based upon SAC review feedback 04/01/2008 0.5 John Fischer Modified based upon LSARC business meeting 06/10/2008 adding familiarity question and mod dates. 0.6 John Fischer Modified based upon user feedback about 06/20/2008 sections that were unanswerable. 0.2 Purpose Architecture review at Sun has allowed the company to evolve our projects within multiple disjoint groups while still maintaining a cohesive product line. Each architecture review was conducted within Sun's control. With the advent of Free Open Source Software processes the control that Sun as a company can wield has been diminished. Now that Sun is moving to a more fluid delivery mechanism with project Indiana we need to evolve the architecture review process. This document is meant to aid in the architecture review process. Each new project must complete this check list to help ensure that the overall resulting product conforms to Sun product standards. If the project deviates from these standards further review would be necessary by an architecture review committee. After the check list is completed the project team should be able to determine if a project can be automatically approved. This will occur if all checks result in no "ARC review required" answers. A committee member will assist the project team in filing the automatically approved fast track. An automatically approved fast track is still required in order to record the interfaces for future reference. If the project needs to have further review then follow the regular process for getting projects reviewed. 1.0 Project Information 1.1 Name of project/component Doxygen: Source Code Documentation Tool 1.2 Author of document Frank Jennings (Frank.Jennings@Sun.COM) 2.0 Project Summary 2.1 Project Description This project proposes to integrate Doxygen version 1.5.6, an open source documentation tool for source code written in C, C++, and Java. 2.2 Release binding What is is the release binding? (see http://opensolaris.org/os/community/arc/policies/release-taxonomy/) [ ] Major [*] Minor [ ] Patch or Micro [ ] Unknown -- ARC review required 2.3 Type of project Is this case a Linux Familiarity project? [*] Yes [ ] No 2.4 Originating Community 2.4.1 Community Name Doxygen 2.4.2 Community Involvement Indicate Sun's involvement in the community [ ] Maintainer [ ] Contributor [*] Monitoring Will the project team work with the upstream community to resolve architectural issues of interest to Sun? [*] Yes [ ] No - briefly explain Will we or are we forking from the community? [ ] Yes - ARC review required prior to forking [*] No 3.0 Technical Description 3.1 Installation & Sharable 3.1.1S Solaris Installation - section only required for Solaris Software (see http://opensolaris.org/os/community/arc/policies/install-locations/ for details) Does this project follow the Install Locations best practice? [*] Yes [ ] No - ARC review required Does this project install into /usr under [sbin|bin|lib|include|man|share]? [*] Yes [ ] No or N/A Does this project install into /opt? [ ] Yes - explain below [*] No or N/A Does this project install into a different directory structure? [ ] Yes - ARC review required [*] No or N/A Do any of the components of this project conflict with anything under /usr? (see http://opensolaris.org/os/community/arc/caselog/2007/047/ for details) [ ] Yes - explain below [*] No If conflicts exist then will this project install under /usr/gnu? [ ] Yes [ ] No - ARC review required [*] N/A Is this project installing into /usr/sfw? [ ] Yes - ARC review required [*] No 3.1.1W Windows Installation - section only required for Windows Software (see http://sac.sfbay/WSARC/2002/494 for details) Does this project install software into a :\Program Files\Sun\ or :\Sun\ directory? [ ] Yes [ ] No - ARC review required Does the project use the Windows registry? [ ] Yes [ ] No - ARC review required Does the project use HKEY_LOCAL_MACHINE\SOFTWARE\Sun Microsystems\\ for the registry key? [ ] Yes [ ] No - ARC review required Is the project's stored location HKEY_LOCAL_MACHINE\SOFTWARE\Sun Microsystems\\\Path? [ ] Yes [ ] No - ARC review required 3.1.2 Share and Sharable Does the module include any components that are used or shared by other projects? [ ] Yes [*] No If yes are these components packaged to be shared with the other FOSS? [ ] Yes [ ] No - ARC review required [*] N/A Are these components already in the Solaris WOS? [ ] Yes [*] No - continue with next section (section 3.2) If yes are these newer versions being delivered? [ ] Yes [ ] No - ARC review required If yes are the newer versions replacing the existing versions? [ ] Yes [ ] No - ARC review required 3.2 Exported Libraries Are libraries being delivered by this project? [ ] Yes [*] No - continue with next section (section 3.3) Are 64-bit versions of the libraries being delivered? [ ] Yes [ ] No - ARC review required Are static versions of the libraries being delivered? [ ] Yes - ARC review required [ ] No 3.3 Services and the /etc Directory (see http://opensolaris.org/os/community/arc/policies/SMF-policy/) Does the project integrate anything into /etc/init.d or /etc/rc?.d? [ ] Yes - ARC review required [*] No Does the project integrate any new entries into /etc/inittab or /etc/inetd.conf? [ ] Yes - ARC review required [*] No Does the project integrate any private non-public files into /etc/default or /etc/ configuration files? [ ] Yes - ARC review required [*] No Does the service manifests method context grant rights above that of the noaccess user and basic privilege set? [ ] Yes - ARC review required [*] No 3.4 Security 3.4.1 Secure By Default (see http://opensolaris.org/os/community/arc/policies/secure-by-default/ for details) (see http://www.opensolaris.org/os/community/arc/policies/NITS-policy/ for details) (see parts of http://opensolaris.org/os/community/arc/policies/SMF-policy/ for addtional details) Are there any network services provided by this project? [ ] Yes [*] No - continue with the next section (section 3.4.2) Are network services enabled by default? [ ] Yes - ARC review required [ ] No [ ] N/A Are network services automatically enabled by the project during installation? [ ] Yes - ARC review required [ ] No [ ] N/A Are inbound network communications denied by default? [ ] Yes [ ] No - ARC review required [ ] N/A Is inbound data checked to prevent content-based attacks? [ ] Yes [ ] No - ARC review required [ ] N/A Is the outbound receiver authenticated? [ ] Yes [ ] No - ARC review required [ ] N/A Is the receiver authenticated prior to receiving any sensitive outbound communication? [ ] Yes [ ] No - ARC review required [ ] N/A 3.4.2 Authorization (see http://opensolaris.org/os/community/arc/bestpractices/rbac-intro/ and http://opensolaris.org/os/community/arc/bestpractices/rbac-profiles/ and http://opensolaris.org/os/community/arc/bestpractices/rbac-profiles/ for details) Are there any setuid/setgid privileged binaries in the project? [ ] Yes - ARC review required [*] No - continue with next section (section 3.4.3) If yes then are the setuid/setgid privileges handled by the use of roles? [ ] Yes [ ] No - ARC review required 3.4.3 Auditing (see http://opensolaris.org/os/community/arc/policies/audit-policy/ for details) (see http://opensolaris.org/os/community/arc/caselog/2003/397 for details) Does this component contain administrative or security enforcing software? [ ] Yes - ARC review required [*] No - continue to next section (section 3.4.4) (see http://opensolaris.org/os/community/arc/caselog/2003/397 for details) Do the components create audit logs detailing what took place including what event took place, who was involved, when the event took place? [ ] Yes - ARC contract and Audit project team review required [ ] No - ARC review required 3.4.4 Authentication (see http://opensolaris.org/os/community/arc/policies/PAM/) Do the components contain any authentication code? [ ] Yes [*] No - continue to next section (section 3.4.5) If yes do the components use PAM (plugable authentication modules) for authentication? [ ] Yes [ ] No - ARC review required If yes is a single PAM session maintained during authentication? [ ] Yes [ ] No - ARC review required If yes are the components sufficiently privileged to allow the requested operations (authentication, password change, process credential manipulation, audit state initialization)? [ ] Yes - briefly describe below [ ] No - ARC review required 3.4.5 Passwords (see http://opensolaris.org/os/community/arc/bestpractices/passwords-cli/ and http://opensolaris.org/os/community/arc/bestpractices/passwords-files/ for details) Do any of the components for the project deal with passwords? [ ] Yes [*] No - continue to next section (section 3.4.6) If yes are these passwords entered via the CLI or environment? [ ] Yes - ARC review required [ ] No Are passwords stored within the file system for the component? [ ] Yes [ ] No - continue to next section (section 3.4.6) If yes are the permissions on the file such to protect exposing the password(s)? [ ] Yes [ ] No - ARC review required 3.4.6 General Security Questions (see http://opensolaris.org/os/community/arc/bestpractices/security-questions/ for details) Are there any network protocols used by this project? [ ] Yes [*] No - continue with the next section (section 3.5) Do the components use standard network protocols? [ ] Yes [ ] No - ARC review required Do network services for the project make decisions based upon user, host or service identities? [ ] Yes - explain below [ ] No [ ] N/A Do the components make use of secret information during authentication and/or authorization? [ ] Yes - explain below [ ] No [ ] N/A 3.5 Networking Do the components access the network? [ ] Yes [*] No - continue with the next section (section 3.6) If yes do the components support IPv6? [ ] Yes [ ] No - ARC review required 3.6 Core Solaris Components Do the components of this project compete with or duplicate core Solaris components? [ ] Yes - ARC review required [*] No Examples of Core Solaris Components include but are not limited to: Secure By Default Authorizations PAM -- Plugable Authentication Module Privilege PRM -- Process Rights Management -- Privilege Audit xVm -- Virtualization zones / Solaris Containers PRM -- Process Rights Management RBAC -- Role Based Access Control TX / Trusted Extensions ZFS SMF -- Service Management Facility FMA -- Fault Management Architecture SCF -- Smart Card Facility IPsec 4.0 Interfaces (see http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/ for details) 4.1 Exported Interfaces NAME STABILITY NOTES /usr/bin/doxygen Uncommitted Executable location /usr/bin/doxytag Uncommitted Executable location /usr/share/man/man1/doxygen.1 Uncommitted Man Page for doxygen command /usr/share/man/man1/doxytag.1 Uncommitted Man Page for doxytag command /usr/share/doc/doxygen-1.5.6/doxygen_manual-1.5.6.pdf Uncommitted Doxygen User Guide (PDF) SUNWdoxygen Committed Doxygen Package 4.2 Imported Interfaces Interface Name Classification Comments --------------------------- -------------------- -------------------------- None --Boundary_(ID_SO+7eydRtN5OgdjIP6pvug)--