[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Please check these descriptions



On Sun, Oct 12, 2003 at 03:23:32AM +0200, Nicolas Boullis wrote:
> Package: em8300
> Description: Software for DXR3/Hollywood+ decoder cards

s/Software/software/

Let the front-end capitalize the short description if it wants to.

>  Drivers for MPEG decoder cards based on Sigma Designs' EM8300 chip
>  (such as the Creative Labs DXR3 or the Sigma Designs Hollywood+).

This is not a sentence.

s/Drivers/This package contains drivers/.

>  Currently the device drivers support decoding MPEG-1 and MPEG-2 streams 
>  and generates video on the TV-out and VGA Overlay connectors. Audio can

Subject-verb agreement.  "...the device drivers...generates" is not
grammatical.

s/generates/generate/

>  be played through the analog or S/PDIF digital connectors.
>  .
>  This package contains scripts needed for testing the card and for 
>  extracting the needed microcode for the em8300 from the windows drivers.

Just a touch awkward, but not wrong (except for failure to capitalize
the proper noun "Windows").  I recommend:

This package contains scripts needed for testing the card and extracting
needed microcode from the Windows drivers.

That the needed microcode is for the EM8300 seems implicit given the
package's name and the first sentence of the extended description.

> Package: em8300-source
> Description: Kernel module for DXR3/Hollywood+ decoder cards (source)

s/Kernel/kernel/

Also, I'd drop " (source)" from the end, and say "kernel module source"
instead.

>  Drivers for MPEG decoder cards based on Sigma Designs' EM8300 chip
>  (such as the Creative Labs DXR3 or the Sigma Designs Hollywood+).

As before.

s/Drivers/This package contains the source code to drivers/

>  Currently the device drivers support decoding MPEG-1 and MPEG-2 streams 
>  and generates video on the TV-out and VGA Overlay connectors. Audio can
>  be played through the analog or S/PDIF digital connectors.

As before; you need subject-verb agreement.

>  Source of kernel modules that create access to the specified cards. 

Not a sentence.

Also, access probably isn't "created"; most likely, it's "allowed" or
"enabled".

>  Those modules are currently without devfs support.

Those?  What modules are "those"?  Do you mean "these" modules in the
package?

> Package: em8300-bin
> Description: Tools to setup DXR3/Hollywood+ decoder cards

s/Tools/tools/

"Setup" is a noun referring to a configuration.  "Set up" is a verb, and
that's how you're using it.

s/setup/set up/

Or punt on the whole issue and say "configure".

>  em8300-dhc can be used to adjust the brightness, contrast, saturation,
>  aspect ration, TV output standard (PAL, NTSC, and PAL 60), turn on and

s/ration/ratio/

>  off the sub-pictures (subtitles, etc.), and change between analog and
>  S/PDIF audio outputs. 
>  .
>  autocal is used for doing initialization of overlay settings after Xine

What's "autocal"?  Is it the name of a tool in this package, a tool in
another package, or the name of another package altogether?

>  or OMS (or some other player capable of handling em8300-based cards) has
>  been started.
>  .
>  dxr3view can be used to fine tune the size, shape, and appearance of
>  the overlay to a certain extent. 

Ah, I see.  Perhaps the first sentence of the extended description
should be:

 This package provides command-line utilties for configuring
 EM8300-based MPEG decoder cards.

> Package: em8300-headers
> Description: Kernel headers to access DXR3/Hollywood+ decoder cards

s/Kernel/kernel/

The headers themselves don't provide access, do they?

I'd say:

  kernel headers for programs that use em8300 device driver

Yes, this description is more technical, but it probably should be.
It's only relevant to developers.

>  This package provides header files to compile applications that use
>  directly the kernel module for MPEG decoder cards based on Sigma
>  Designs' EM8300 chip (such as the Creative Labs DXR3 or the Sigma
>  Designs Hollywood+).

That sentence feels awkward.

How about:

 This package provides C header files for inclusion by applications
 which interface with the em8300 kernel module for MPEG decoder cards
 based on Sigma Designs' EM8300 chip (such as the Creative Labs DXR3 or
 the Sigma Designs Hollywood+).

-- 
G. Branden Robinson                |
Debian GNU/Linux                   |      Please do not look directly into
branden@debian.org                 |      laser with remaining eye.
http://people.debian.org/~branden/ |

Attachment: signature.asc
Description: Digital signature


Reply to: