Closed Bug 685899 Opened 13 years ago Closed 13 years ago

AVM2 Specification in Doxygen format

Categories

(Tamarin Graveyard :: Documentation, defect, P3)

Product:
Tamarin Graveyard
Component:
Documentation
Platform:
x86
macOS
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED FIXED
Milestone:
Q1 12 - Brannan

People

(Reporter: akruetzf, Assigned: edwsmith)

References

Details

(Whiteboard: loose-end)

Attachments

(5 files, 11 obsolete files)

Updated spec patch bomb
615.46 KB, patch
Details | Diff | Splinter Review
Legal formated
2.79 KB, patch
Details | Diff | Splinter Review
adobe legal
70.96 KB, patch
Details | Diff | Splinter Review
Adobe legal 2
3.15 KB, patch
Details | Diff | Splinter Review
Adobe doc generate
277 bytes, patch
Details | Diff | Splinter Review 
This is the additional AVM2 specification that hosts the byte code and describes the overall architecture. It replaces the "old" pdf AVM2Overview.
jsudduth: Once this gets pushed we should modify the build/buildbot/slaves/all/build-doxygen.sh script to generate this document as well and also post it to http://tamarin-builds.mozilla.org/doxygen/html/
Flags: flashplayer-qrb?
Attached patch Initial avmspec patch (obsolete) — — Splinter Review 

        Attachment #559492 -
        Flags: review?(edwsmith)

    
    

    
  
Brent/James: I'll have another patch by COB that will cleanup and generate the html directory, so that developers can generate the material.

    
    

    
  


  

    
    

    
  
Looking for a review or feedback?
Flags: flashplayer-qrb? → flashplayer-qrb+
Priority: -- → P3
Whiteboard: loose-end
Target Milestone: --- → Q1 12 - Brannan

    
    

    
  

      
      
      
      

        Attached patch
          
          
        Format fixes (obsolete)
        — 
          — Splinter Review
      

    


  

        Attachment #559492 -
        Attachment is obsolete: true

        Attachment #559623 -
        Attachment is obsolete: true

        Attachment #559492 -
        Flags: review?(edwsmith)

    
  

        Attachment #559867 -
        Attachment is patch: true

    
    

    
  

      
      
      
      

        Attached patch
          
          
        avm spec incl. fix for 567107 (obsolete)
        — 
          — Splinter Review
      

    


  
Now including https://bugzilla.mozilla.org/show_bug.cgi?id=567107

        Attachment #559867 -
        Attachment is obsolete: true

    
    

    
  

      
      
      
      

        Attached patch
          
          
        avm spec incl. fix for 557640 (obsolete)
        — 
          — Splinter Review
      

    


  

        Attachment #559871 -
        Attachment is obsolete: true

    
    

    
  


  
All avm spec bugs included and unneeded generated code removed. Closing https://bugzilla.mozilla.org/show_bug.cgi?id=623725

        Attachment #559872 -
        Attachment is obsolete: true

        Attachment #559873 -
        Flags: review?(edwsmith)

    
    

    
  
After R+ ready to land as third patch. Passing bug to Edwin for landing.
Assignee: akruetzf → edwsmith

    
    

    
  
Is this bug the "official" dupe of bug 416391?  If so, can close bug 416391.

    
    

    
  
bug 416391 morphed into my tracking bug. But this one has to land as the "mega-patch".

    
  
Blocks: avmspec

    
  
Depends on: 646541

    
  
Blocks: 646541
No longer depends on: 646541

    
  

        Attachment #559873 -
        Attachment description: avm spec incl. fix for 623725 → avm spec including fix for 623725

        Attachment #559873 -
        Attachment filename: avmspec.patch → avmspec-patch

    
    

    
  
Whats here looks right, and its nice to see the full chapter 4.

the patch adds two doxyfiles:
  doc/avmspec/spec.doxyfile
  doc/spec.doxyfile

These appear unchanged (no problem)
  doc/bytecode/...
  doc/bytecode.doxyfile

If I run:
 $ cd doc/avmspec
 $ doxygen spec

Then I get a spec dir with html and latex, which doesn't contain the bytecode
descriptions.  

If I run:
 $ cd doc
 $ doxygen spec

I get:
warning: tag INCLUDE_PATH: include path `doc/avmspec/bytecode' does not exist
warning: tag INPUT: input source `doc/avmspec/legal.dox' does not exist
... and so on, then
error: tag OUTPUT_DIRECTORY: Output directory `docs/spec' does not exist and cannot be created
Exiting...

So, could add a README or something to the patch that makes it clear how to
generate the full spec content?  mainly: where to cd, what command to run.

    
  

        Attachment #559873 -
        Flags: review?(edwsmith) → review-

    
    

    
  
I'll plan to add a script that does all the clean up and generation when I do have all doc files done.

    
    

    
  

      
      
      
      

        Attached file
          
        Updated spec file (obsolete)
        — 
      

    


  
Updated spec.doxyfile, now generating the spec in doc/docs/...

        Attachment #560229 -
        Flags: review?(edwsmith)

    
  

        Attachment #560229 -
        Attachment is obsolete: true

        Attachment #560229 -
        Flags: review?(edwsmith)

    
    

    
  
That is correct.

(In reply to Edwin Smith from comment #16)
> Created attachment 560232 [details] [diff] [review]
> Replace doc/spec.doxyfile, remove doc/bytecode.doxyfile, remove
> doc/avmspec/spec.doxyfile

    
    

    
  

      
      
      
      

        Attached file
          
        Spec file with MOPS (obsolete)
        — 
      

    


  
Updates spec file to include mops instructions

    
    

    
  


  

    
    

    
  
Comment on attachment 560277 [details]
Spec file with MOPS

This belongs on bug 624221 in the form of a patch

    
  

        Attachment #560277 -
        Attachment is obsolete: true

    
    

    
  
Spec file patch moved to 624221

    
  

        Attachment #560232 -
        Flags: feedback?(akruetzf) → review?(dansmith)

    
    

    
  


  
This patch subsumes all previous patches.

The main (only) doxyfile is named doc/avmspec.doxyfile.

to run: $ cd doc; doxygen avmspec.doxyfile

output goes to doc/avmspec-generated.

        Attachment #559873 -
        Attachment is obsolete: true

        Attachment #560232 -
        Attachment is obsolete: true

        Attachment #560278 -
        Attachment is obsolete: true

        Attachment #560232 -
        Flags: review?(dansmith)

    
    

    
  
The legal page contents should be replaced with this text:


Copyright © 2006–2011 Adobe Systems Incorporated. All rights reserved.

Adobe, the Adobe Logo, and ActionScript, are trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. All other trademarks are the property of their respective owners.

This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and noninfringement of third party rights.

Adobe Systems Incorporated
345 Park Avenue
San Jose, CA 95110
(408) 536-6000

    
    

    
  

      
      
      
      

        Attached patch
          
          
        Updated legal (obsolete)
        — 
          — Splinter Review
      

    


  

    
    

    
  

      
      
      
      

        Attached patch
          
          
        Legal formated
        — 
          — Splinter Review
      

    


  
Now bold and address formatted.

        Attachment #560351 -
        Attachment is obsolete: true

    
    

    
  

      
      
      
      

        Attached patch
          
          
        adobe legal
        — 
          — Splinter Review
      

    


  

    
    

    
  

      
      
      
      

        Attached patch
          
          
        Adobe legal 2
        — 
          — Splinter Review
      

    


  

    
    

    
  


  

    
  
Blocks: 685660

    
    

    
  
changeset: 6599:da6f9fa3b354
user:      Andre Kruetzfeldt <akruetzf>
summary:   Bug 685899 - "AVM2 Specification in Doxygen format" (r=dsmith+)

http://hg.mozilla.org/tamarin-redux/rev/da6f9fa3b354

    
  
Status: NEW → RESOLVED
Closed: 13 years ago
Resolution: --- → FIXED

          You need to log in
          before you can comment on or make changes to this bug.
        






  

    
  







  

    

      
Attachment

      

      
      
      
      
    

    

      

        

          

            
General

            

              Creator: 



            

            
Created: 

            
Updated: 

            
Size: