Project

General

Profile

Feature #1472

expand the Developer Guide section on "Guidelines for Writing Conversion Conforming Code"

Added by Greg Shah almost 12 years ago. Updated over 11 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
Start date:
08/08/2012
Due date:
% Done:

90%

billable:
No
vendor_id:
GCD
version_reported:
version_resolved:

History

#1 Updated by Greg Shah almost 12 years ago

This is a section at the end of the hand_written_java.odt chapter of the Developer Guide. I had previously thrown in some ideas there as a placeholder. The idea:

1. Do not duplicate content in the Conversion Reference. That book is meant to be the ultimate location to look for how "conversion conforming code" is emitted, since it defines how the conversion emits code. Reference things there as needed. Make it very clear that the reader MUST read the Conversion Reference book carefully as it is the canonical source for conformance.

2. There may be some related content that already exists in the dev guide, relating to how to integrate hand written code. Don't duplicate that. Reference things there as needed.

3. This section is to highlight the unique issues that someone writing conversion conforming code BY HAND would have to deal with. It must explain these pitfalls and important tricks/tips and so forth in enough detail to help the reader avoid problems.

4. There may be some content in that getting_started_with_p2j.odt from 20110214 which you and Stanislav wrote for TIMCO. If so, pull out the ideas and write a better version of it here. Again: don't duplicate stuff in the reference, but do explain things that may not be obvious in the reference or which only affect code that is written by hand.

Once you have an outline of the content, review it with Eric, Stanislav and myself so that we can try to get it right together.

#2 Updated by Constantin Asofiei almost 12 years ago

The hand_written.odt file in bazaar now has notes about what should be covered and how to structure it.

#3 Updated by Constantin Asofiei over 11 years ago

  • Status changed from WIP to Review
  • % Done changed from 0 to 90

The updated hand_written_java.odt file is in bazaar.

#4 Updated by Greg Shah over 11 years ago

  • Status changed from Review to Closed

Also available in: Atom PDF