Opened 17 years ago
Last modified 10 years ago
#146 new task
IZ870: drmaa.h doc needs clarified
Reported by: | tharsch | Owned by: | |
---|---|---|---|
Priority: | lowest | Milestone: | |
Component: | sge | Version: | 6.0beta |
Severity: | Keywords: | PC Windows drmaa | |
Cc: |
Description
[Imported from gridengine issuezilla http://gridengine.sunsource.net/issues/show_bug.cgi?id=870]
Issue #: 870 Platform: PC Reporter: tharsch (tharsch) Component: gridengine OS: Windows 2000 Subcomponent: drmaa Version: 6.0beta CC: None defined Status: NEW Priority: P5 Resolution: Issue type: TASK Target milestone: --- Assigned to: andreas (andreas) QA Contact: templedf URL: * Summary: drmaa.h doc needs clarified Status whiteboard: Attachments: Issue 870 blocks: Votes for issue 870: Opened: Tue Mar 16 15:35:00 -0700 2004 ------------------------ consider the header for drmaa_version, which fails to describe the return value. /* * If called before drmaa_init(), it SHALL return a comma delimited default * DRMAA implementation contacts string, one per each DRM system provided * implementation. If called after drmaa_init(), it SHALL return the selected * contact string. The output string is Implementation dependent. * drmaa_get_contact() SHALL return DRMAA_ERRNO_SUCCESS on success, otherwise: * DRMAA_ERRNO_INTERNAL_ERROR. */ int drmaa_get_contact(char *contact, size_t contact_len, char *error_diagnosis, size_t error_diag_len); /* * OUT major - major version number (non- negative integer) * OUT minor - minor version number (non- negative integer) * SHALL return the major and minor version numbers of the DRMAA library; * for DRMAA 1.0, 'major' is 1 and 'minor' is 0. */ int drmaa_version(unsigned int *major, unsigned int *minor, char *error_diagnosis, size_t error_diag_len); ------- Additional comments from templedf Tue Aug 30 04:31:17 -0700 2005 ------- Now that we have a C binding specification that is more than just a header file, we should probably copy and paste the text from it into our header file, much like I did with the Java language binding spec and the Java language binding JavaDocs.
Note: See
TracTickets for help on using
tickets.