[Pkg-electronics-devel] New geda-xgsch2pcb version

[Peter Clifton]

On Sat, 2010-01-02 at 18:12 +0200, أحمد المحمودي wrote:
> Hello,
> 
> On Thu, Dec 31, 2009 at 10:51:27AM +0200, أحمد المحمودي wrote:
> > Can you add a man page for geda-xgsch2pcb ?
> ---end quoted text---
> 
>   I've made a manpage for xgsch2pcb, based on the README file shipped 
>   with the upstream tarball. Please have a look at it on:
>   http://git.debian.org/?p=pkg-electronics/geda-xgsch2pcb.git;a=blob_plain;f=debian/xgsch2pcb.1
> 


"
> In order for the update process to work properly, you should never
> launch \fIpcb\fP to edit your PCB layout except through \fIxgsch2pcb\fP.
> If you are editing the layout without \fIxgsch2pcb\fP running and then
> wish to edit your layout you should close \fIpcb\fP, launch
> \fIxgsch2pcb\fP and then use the 'Edit layout' button to launch \fIpcb\fP
> again.
"

That isn't correct any more.. but I see it is indeed in the README..
I'll remove that paragraph! Can you take it out of the manpage too
please.

Since we changed to dbus, it doesn't matter who launches PCB, as long as
the correct file is open, it will be found.


I'm not personally that convinced of the merits of having comprehensive
manpages for GUI apps. (I can completely see it for command line ones
though). Debian policy states that apps should have manpages, and I'm
not against including a simple one upstream - it certainly doesn't
detract from anything.

I'd be more inclined, if we included one upstream, to keep it very
minimal. By describing the GUI and operation in detail, I'd then have
the app, the README _and_ the manpage to update, every time there is any
substantial change - they _will_ get out of sync, as with the above
paragraph!

I might be inclined to cut if off just before:

""
.PP
The main window is divided into three main areas:
""

(Skipping the detailed UI description), and perhaps retain something of
the footer (reworded):

""
.PP
xgsch2pcb provides some advantages over using gsch2pcb directly.

The update process won't modify your PCB file on disk until you save it
within PCB, thus allowing you to verify the changes it makes.

Since xgsch2pcb works on an open PCB design, you can also update designs
which have un-saved changes, and without closing PCB.
""



Thanks for creating the manpage.. the more "standards compliant" these
packages become, the easier it is to keep them updated in Debian. I look
forward to taking this upstream.

Best wishes,

Peter C.