Ticket #1679 (closed bug: fixed)

Opened 4 years ago

Last modified 4 years ago

examples/compilers/japhc.c: Misleading documentation

Reported by: jkeenan Owned by: jkeenan
Priority: normal Milestone:
Component: docs Version: 2.4.0
Severity: medium Keywords:
Cc: allison, fperrad, cotto, chromatic, infinoid Language:
Patch status: Platform:

Description

=head1 NAME

examples/compiler/japhc.c

My attention was drawn to this file because, during my work in the cfunctiondocs branch, it showed up as one of the last documents still failing t/codingstd/c_function_docs.t. Here is the start of this file's POD:

=head1 DESCRIPTION

example compiler used by japh16.pasm

=head1 SYNOPSIS


  $ make -C examples/compilers/
  $ parrot examples/japh/japh16.pasm

Problem: There is no such file as examples/japh/japh16.pasm. In the course of testing we apparently create these files:

      t/examples/japh_1.pasm
      t/examples/japh_3.pasm
      t/examples/japh_4.pasm
      t/examples/japh_5.pasm

... but no japh_16 or japh16 (and where did japh_2.pasm go?).

Can anyone clarify? (The code is several years old. I'm going to CC anyone who has touched it in recent years.)

Thank you very much.

kid51

Change History

follow-up: ↓ 2   Changed 4 years ago by coke

there were a lot of JAPHs that had to be removed in the past 8 years or so as things they depended on were removed - the remaining ones were never renumbered.

in reply to: ↑ 1   Changed 4 years ago by jkeenan

  • status changed from new to assigned
  • owner set to jkeenan

Replying to coke:

there were a lot of JAPHs that had to be removed in the past 8 years or so as things they depended on were removed - the remaining ones were never renumbered.

So is there *any* reason to keep this file in Parrot trunk at this time?

I will delete the file within 7 days if there is no objection.

Thank you very much.

kid51

follow-up: ↓ 6   Changed 4 years ago by coke

+1 on

 rm -rf examples/japh t/examples/japh.t

The examples are merely cute, they're in PASM, and they're more trouble than they're worth.

follow-up: ↓ 5   Changed 4 years ago by coke

  • owner changed from jkeenan to kid51
  • status changed from assigned to new

in reply to: ↑ 4   Changed 4 years ago by jkeenan

  • owner changed from kid51 to jkeenan
  • status changed from new to assigned

Replying to coke: As far as Trac officially knows, I am jkeenan. Switching ownership.

in reply to: ↑ 3   Changed 4 years ago by jkeenan

  • status changed from assigned to closed
  • resolution set to fixed

Replying to coke:

+1 on {{{ rm -rf examples/japh t/examples/japh.t }}}

Executed in r48776. Closing ticket.

Thank you very much.

kid51

Note: See TracTickets for help on using tickets.