emacs IDE and org

emacs IDE and org

[Rockefeller, Harry]

[-- Attachment #1.1: Type: text/plain, Size: 997 bytes --]

Is anyone using org mode in a software development process? An IDE,
emacs is no exception, assumes the source code is primary, having tools
and methods to edit source code files but not org files.  org files,
however, appear to have all those other features desired in a
development process: todo items, requirements specifications, reference
links, tabular and spreadsheet data, etc.  Export of various parts of
the org file at different times of development may coincide with
software process milestones.

 

Org to source code seems straight forward via QUOTE, for example.  From
source to org may be set up using special 'org import' markers such as 

//* Top item

//  bla bla

//** Sub item

// bla bla 

where the cpp source comment character may get snipped off to use source
to generate an org file.  Either the source or the org file may be
primary.  Or maybe the org file is primary early in this process and
eventually is replaced by source toward the end?


[-- Attachment #1.2: Type: text/html, Size: 2993 bytes --]

[-- Attachment #2: Type: text/plain, Size: 204 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: emacs IDE and org

[Tim O'Callaghan]

2008/5/9 Rockefeller, Harry <Harry.Rockefeller@flightsafety.com>:
> Is anyone using org mode in a software development process? An IDE, emacs is
> no exception, assumes the source code is primary, having tools and methods
> to edit source code files but not org files.  org files, however, appear to
> have all those other features desired in a development process: todo items,
> requirements specifications, reference links, tabular and spreadsheet data,
> etc.  Export of various parts of the org file at different times of
> development may coincide with software process milestones.
>
>

I use Emacs for development, and have used Org to group together file
links and notes
for various projects.

>
> Org to source code seems straight forward via QUOTE, for example.  From
> source to org may be set up using special 'org import' markers such as
>
> //* Top item
>
> //  bla bla
>
> //** Sub item
>
> // bla bla
>
> where the cpp source comment character may get snipped off to use source to
> generate an org file.  Either the source or the org file may be primary.  Or
> maybe the org file is primary early in this process and eventually is
> replaced by source toward the end?
>

This sounds a bit like you want to use org for something like
"Literate Programming"?

Tim.

RE: emacs IDE and org

[Rockefeller, Harry]

I'm taking some time to brainstorm a bit.  Yes, the thought I was
expressing below using the QUOTE org syntax is something akin to
literate programming.  Using org for the simplicity of an ASCII
formatting "language" where source code may be embedded in the actual
org file.

At our company, historically, we have a "suggested" documentation
process which "requires" source to have special formatting characters
along with comments so that it may be parsed to produce "documentation"
- a kind of "literate programming" in reverse.  Not only is this
documentation not enforced, but often the code comments don't even match
the fixes made to code over time.  In other words, our corporate process
could use some help.  Also, now we are an ISO 9001 shop and have to pay
closer attention to our software process.

My personal process originated in the UNIX world where I continue using
open source development tools: emacs "IDE" with svn for my personal
repository vs the corporate tools which have migrated from UNIX to
Micro$oft dev studio and VSS.  I am comfortable using my personal
software process but obviously a solution is for me to just conform.

Nevertheless, our corporate software process is sketchy at best at the
front end.  Just naming a few items which project documentation may
contain in a "note" if nothing else, would include:  1) Description, 2)
requirements, 3) references, 4) design, 5) READMEs (HowTos), 6) ToDos,
7) Block diagram(s), and 8) Issues (problems and fixes for these
problems).  The nature of the project may dictate the necessity or
importance of these.

From your brief statement below, Tim, I would imagine you would
reference files of perhaps block diagrams, reference documents, and code
via links inside of an org file which may directly contain descriptions,
requirements, design, ToDos, and READMEs?  A software repository would
usually take care of the Issue details.  Maybe I'm trying to jump to far
ahead?  This would be a good way to get my "feet wet" to begin by using
org as a project "wrapper" file.  In other words, begin using org by
adding the stuff I think is important but have not yet written down and
then linking my existing files together?  Unless I hear something better
from anyone else, I think I'll start with that.  Just thinking out loud
... :-)

> -----Original Message-----
> From: emacs-orgmode-bounces+harry.rockefeller=flightsafety.com@gnu.org
>
[mailto:emacs-orgmode-bounces+harry.rockefeller=flightsafety.com@gnu.org
]
> On Behalf Of Tim O'Callaghan
> Sent: Friday, May 09, 2008 11:31 AM
> To: org-mode mailing list
> Subject: Re: [Orgmode] emacs IDE and org
> 
> 2008/5/9 Rockefeller, Harry <Harry.Rockefeller@flightsafety.com>:
> > Is anyone using org mode in a software development process? An IDE,
> emacs is
> > no exception, assumes the source code is primary, having tools and
> methods
> > to edit source code files but not org files.  org files, however,
appear
> to
> > have all those other features desired in a development process: todo
> items,
> > requirements specifications, reference links, tabular and
spreadsheet
> data,
> > etc.  Export of various parts of the org file at different times of
> > development may coincide with software process milestones.
> >
> >
> 
> I use Emacs for development, and have used Org to group together file
> links and notes
> for various projects.
> 
> >
> > Org to source code seems straight forward via QUOTE, for example.
From
> > source to org may be set up using special 'org import' markers such
as
> >
> > //* Top item
> >
> > //  bla bla
> >
> > //** Sub item
> >
> > // bla bla
> >
> > where the cpp source comment character may get snipped off to use
source
> to
> > generate an org file.  Either the source or the org file may be
primary.
> Or
> > maybe the org file is primary early in this process and eventually
is
> > replaced by source toward the end?
> >
> 
> This sounds a bit like you want to use org for something like
> "Literate Programming"?
> 
> Tim.
> 
> 
> _______________________________________________
> Emacs-orgmode mailing list
> Remember: use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode