<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://jogamp.org/bugzilla/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.2"
          urlbase="https://jogamp.org/bugzilla/"
          
          maintainer="sgothel@jausoft.com"
>

    <bug>
          <bug_id>1449</bug_id>
          
          <creation_ts>2023-08-09 15:18:02 +0200</creation_ts>
          <short_desc>Update GlueGen Documentation</short_desc>
          <delta_ts>2023-08-14 04:43:21 +0200</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>3</classification_id>
          <classification>JogAmp</classification>
          <product>Gluegen</product>
          <component>core</component>
          <version>2.5.0</version>
          <rep_platform>All</rep_platform>
          <op_sys>all</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>P4</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>---</target_milestone>
          
          <blocked>1451</blocked>
          <everconfirmed>1</everconfirmed>
          <reporter name="Sven Gothel">sgothel</reporter>
          <assigned_to name="Sven Gothel">sgothel</assigned_to>
          <cc>mfery</cc>
          
          <cf_type>DEFECT</cf_type>
          <cf_scm_refs>9b825a445c3d2646546306c1815f498406e2f8c3
fd623305d90a88fd01dea3dccf6b9fe76b19703f
9250960f107cebbb4e6d3a55009b330f101453ea
8850b3d7f82ca5f1f828192407574581abd82ef9</cf_scm_refs>
          <cf_workaround>---</cf_workaround>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>6840</commentid>
    <comment_count>0</comment_count>
    <who name="Sven Gothel">sgothel</who>
    <bug_when>2023-08-09 15:18:02 +0200</bug_when>
    <thetext>Synchronize GlueGen documentation with current code, i.e. latest code changes as well as some of the JOGL_2_SANDBOX efforts back then.

I started producing a new document as of late covering these matters
- https://jogamp.org/cgit/gluegen.git/tree/doc/GlueGen_Mapping.md

Perhaps we want to make a choice to at least update 
the GlueGen config options in 
https://jogamp.org/gluegen/doc/manual/

I personally prefer using Markdown document format over the html one.
Perhaps we can convert the html version automatically to markdown
and then merge to document?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6848</commentid>
    <comment_count>1</comment_count>
    <who name="Mathieu Féry (MathiusD)">mfery</who>
    <bug_when>2023-08-10 12:17:07 +0200</bug_when>
    <thetext>Yes, synchronizing the manual is necessary, especially for the configuration options.

I also prefer the markdown format, which allows you to concentrate on the content rather than the form imho.

I&apos;m putting all the documentation I&apos;ve made on a branch by the end of the day or tomorrow at the latest.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6849</commentid>
    <comment_count>2</comment_count>
    <who name="Mathieu Féry (MathiusD)">mfery</who>
    <bug_when>2023-08-13 23:33:16 +0200</bug_when>
    <thetext>Sorry for the delay, it&apos;s been a busy week :x, but here&apos;s a partial update of the manual I placed on this branch: 1449-manual-sync-configuration-entries of my branch (https://github.com/MathiusD/gluegen as always)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6850</commentid>
    <comment_count>3</comment_count>
    <who name="Sven Gothel">sgothel</who>
    <bug_when>2023-08-14 02:33:20 +0200</bug_when>
    <thetext>Merged index.html change 9b825a445c3d2646546306c1815f498406e2f8c3
of comment 2.

Thank you Mathieu!</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6851</commentid>
    <comment_count>4</comment_count>
    <who name="Sven Gothel">sgothel</who>
    <bug_when>2023-08-14 04:30:56 +0200</bug_when>
    <thetext>commit fd623305d90a88fd01dea3dccf6b9fe76b19703f

Convert manual/index.html to `gfm` (GitHub-Flavored Markdown) using markdown 
-&gt; manual/index.md 

also adds conversion recipes + make/scripts/md2html_update.sh
    
    Note: Additionally edited &apos;doc/misc/macos_nativelib_dependencies.md`
    to include `Use explicit OpenJDK/Temurin JDK `java` executable path`
    as a workaround to pass `DYLD_LIBRARY_PATH` to `/usr/bin/java`.

+++

Conversion was done using:

  pandoc index.html -t gfm -o index.md</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6852</commentid>
    <comment_count>5</comment_count>
    <who name="Sven Gothel">sgothel</who>
    <bug_when>2023-08-14 04:32:08 +0200</bug_when>
    <thetext>(In reply to Sven Gothel from comment #4)

We convert markdown using pandoc using `gfm` (GitHub-Flavored Markdown) as source format
and `html5+smart` with a custom template as the target.

Recipe:
```
  ~/pandoc-buttondown-cgit/pandoc_md2html_local.sh GlueGen_Mapping.md &gt; GlueGen_Mapping.html
```  

Git repos:
- https://jausoft.com/cgit/users/sgothel/pandoc-buttondown-cgit.git/about/
- https://github.com/sgothel/pandoc-buttondown-cgit</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>6854</commentid>
    <comment_count>6</comment_count>
    <who name="Sven Gothel">sgothel</who>
    <bug_when>2023-08-14 04:43:21 +0200</bug_when>
    <thetext>Closing this portion of GlueGen documentation updates for 2.5.0, 
further work will be done under Bug 1451</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>