Issue 9912 - Documentation for 643C Windows build needs some changes
Summary: Documentation for 643C Windows build needs some changes
Status: CLOSED FIXED
Alias: None
Product: Build Tools
Classification: Code
Component: documentation (show other issues)
Version: 643C
Hardware: PC Other OS
: P3 Trivial (vote)
Target Milestone: OOo 1.1 RC
Assignee: Unknown
QA Contact: issues@tools
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2002-12-06 19:16 UTC by quetschke
Modified: 2003-05-10 11:35 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments
Patch for build_template.html (15.43 KB, patch)
2003-03-31 18:13 UTC, quetschke
no flags Details | Diff
Generated build_windows.html (35.89 KB, text/html)
2003-03-31 18:14 UTC, quetschke
no flags Details

Note You need to log in before you can comment on or make changes to this issue.
Description quetschke 2002-12-06 19:16:04 UTC
The documentation for the 643C Windows build on:

http://www.openoffice.org/dev_docs/source/build_windows.html#BuildRequirements

needs some changes.

If you use the current version of cygwin you have to make sure that

  awk.exe, gunzip.exe and tar.exe

are *NOT* cygwin symlinks. Check with ls -l /bin/<prog> if they are symlinks,
and in case they are, remove the symlink and copy the program it points to
to this name.

In the 

   /build_windows.html#GeneratingtheBuildEnvironmentandBuildTools

part of the file all instructions with  "Please enter the ..."
want to have the "/cygdrive/c/path/to/file" notation in the case of the 643
build. This does not depend on new/old cygwin.

There is a typo in:
"Note the change in pathname notation. Since the cygwin bash shell won't accept
backslashes, paths have to be typed in a cygwin bash notation which is
//C/path/to/file or /cygwin/c/path/to/file for b-20 or new cygwin tools,
respectively, instead of C:\path\to\file."
It has to be /cygdrive/ instead of /cygwin/.

We should use different links for the build instruchtions for OOo 1.0.x and 643C
and up. This would make things easier.
Comment 1 foskey 2002-12-07 04:01:21 UTC
Please remove the 'run autoconf' from teh document as well.
Comment 2 Unknown 2002-12-09 17:06:18 UTC
In principle I agree with splitting the build docs into two 
(one for developer and one for stable branch). Although that 
should converge again. I hope I find time to do that before the 
next stable release. 

In the meantime, I fixed the errors you've found. 
Comment 3 quetschke 2002-12-12 16:27:09 UTC
And another problem:

The cygwin unzip.exe is not working for the w32/4nt build, you have
to use the native w32 version, but configure just checks for a unzip.exe
in your path!

!!!!!!!!!!!!!!
Make sure that the first unzip.exe in your path *IS* the native w32
version. E.g. delete the unzip.exe in your cygwin /bin directory and
copy the InfoZip version to this place.
!!!!!!!!!!!!!!

(I'll try to provide some magic for configure to catch this)
Comment 4 foskey 2002-12-13 08:13:02 UTC
consider a negative check like unzip --version...
Comment 5 quetschke 2002-12-17 11:15:26 UTC
Another small change:

The homepage of Info-ZIP is alive, it is:

http://www.info-zip.org

Version 2.3 of zip is released since December 1999, I'd like
to change the build requirements to this version, since the patch
for configure I send to Ken is only tested with the 2.3 version.
Comment 6 quetschke 2002-12-17 11:19:36 UTC
>The cygwin unzip.exe is not working for the w32/4nt build, you have
>to use the native w32 version, but configure just checks for a
>unzip.exe in your path!

Correction to myself: Not unzip.exe is the problem, but zip.exe.

!!!!!!!!!!!!!!
Make sure that the first zip.exe in your path *IS* the native w32
version. E.g. delete the zip.exe in your cygwin /bin directory and
copy the InfoZip version to this place.
!!!!!!!!!!!!!!
Comment 7 Unknown 2002-12-23 11:04:14 UTC
The zip-related part of the build docs is now as below. 
I will change it again in the future if configure can take 
care of it, or when the 4NT shell becomes obsolete.
  
<li> <CODE>zip.exe</CODE> Version 2.2 or higher, and    
    <CODE>unzip.exe</CODE>.
    If you do not have these already, you can download them from
    <a href="http://www.info-zip.org">www.info-zip.org</a>. 
    Note: The cygwin zip.exe is not working for the build under the 
    4NT shell. 
    You have to use the native w32 version. 
    Make sure that the first zip.exe in your path is the native w32
    version, e.g. rename or delete the zip.exe in your cygwin /bin 
    directory and
    copy the InfoZip version to this place. This issue should become     
    obsolete 
    once the 4NT shell is no longer a requirement for the build 
    environment.
  </li>
Comment 8 quetschke 2003-01-10 09:44:26 UTC
The cvs part of the Build Requirements page is misleading.

What is runsocks?

We should remove the cvs part and insert an link to:

http://www.openoffice.org/dev_docs/source/get_source.html
Comment 9 Joost Andrae 2003-02-17 10:39:54 UTC
JA: re-prioritized according to new priority guide lines
Comment 10 Unknown 2003-02-24 13:52:06 UTC
Acutally, the build documentation was initially a summary of 
a bigger document of which the above URL is one part. We wanted 
to have a build guide on one single html page and only a few 
printed pages. In other words: a much more compact guide. 
Therefore, I personally am opposed to link to these old URLs.

What is misleading in the current description? 

socks: see http://www.socks.permeo.com/

 
Comment 11 quetschke 2003-02-24 14:46:33 UTC
> Acutally, the build documentation was initially a summary of 
> a bigger document of which the above URL is one part. We wanted 
> to have a build guide on one single html page and only a few 
> printed pages. In other words: a much more compact guide. 
> Therefore, I personally am opposed to link to these old URLs.
OK! But <http://www.openoffice.org/dev_docs/source/get_source.html>
is a link directly from <http://tools.openoffice.de>

> What is misleading in the current description? 
I don't need socks, I just start a cygwin shell and enter
my cvs commands.

> socks: see http://www.socks.permeo.com/
Not needed when you use a current cygwin environement, maybe usefull
for cygwin b2x ??

We have a very good cvs help for cygwin on this server already,
<http://website.openoffice.org/support/en/howtos/1.html> describes
how to get cygwin, setup ssh tunnels and use cvs.

Volker
Comment 12 Unknown 2003-03-10 17:08:12 UTC
small updates in respect to runsocks and link to cygwin help. 
I keep the issue open for future changes, for example I want 
to get rid of the references to older builds in which the old 
cygwin shell is needed. I think we don't need to encourage 
people to build old versions
Comment 13 quetschke 2003-03-22 17:18:15 UTC
Armin, can you please tell me where to find the master file
(build_template.html). It's easier to post a patch agoinst the true
file.

Volker
Comment 14 quetschke 2003-03-23 10:03:03 UTC
Just an info! There now is a document in the Cygwin User's Guide
describing the use of setup.exe:
<http://cygwin.com/cygwin-ug-net/setup-net.html>
Comment 15 foskey 2003-03-23 10:53:55 UTC
try:

export  CVSROOT=:pserver:vq@localhost:/cvs


cvs co -A www
Comment 16 quetschke 2003-03-23 15:54:36 UTC
Hmm, well, I asked about the build_template.html because the first lines
of "www/www/dev_docs/source/build_windows.html" say:

<!-- PLEASE DO NOT COMMIT EDITED VERSION OF THE FILES BUILD_LINUX.HTML, 
BUILD_SOLARIS.HTML AND BUILD_WINDOWS.HTML. EDIT THE FILE BUILD_TEMPLATE 
INSTEAD AND USE ./MKBUILDDOC TO GENERATE THE PLATFORM SPECIFIC BUILD
DOCUMENT-->

Probably Armin doesn't keep this file in cvs.
Comment 17 quetschke 2003-03-31 18:12:55 UTC
As cws_srx644_ooo20030412 is now buildable without 4NT I tried to
document the changes in build_template.html.

These changes also remove all text concerning the interactive queries
from the build instructions. See issue 12872.

Attached are the patch for build_template.html and the generated
build_windows.html.

Please check for consistency and typing/spelling/grammar errors.

I don't think this is the best solution, I'd prefer a
  build_windows.html
for the W32-4NT build and a
  build_cygwin.html
for the W32-tcsh build.

Opinions?
Comment 18 quetschke 2003-03-31 18:13:54 UTC
Created attachment 5381 [details]
Patch for build_template.html
Comment 19 quetschke 2003-03-31 18:14:51 UTC
Created attachment 5382 [details]
Generated build_windows.html
Comment 20 quetschke 2003-04-06 19:58:17 UTC
Don't use this patches, use the patches from issue 13097 instead.
Comment 21 Unknown 2003-04-07 14:58:27 UTC
As suggested in the tools mailing list, it is probably a better 
idea to split this windows document into two separate build docs - 
one for win+4nt and one for win tcsh. At the end of the day, we 
want to get rid (not support) win+4nt anymore anyway, because 4nt 
is not free. 

about the build_<platform>.html file header remark: 
I just wanted to avoid people checking in new versions of these 
files directly but use the template instead. I wanted to avoid 
that after time the three documents get a different structure. 
Since the build experience is still more or less the same for 
all three platforms, the build docs should keep the same, too. 

That is all my opinion. What do you think?
Comment 22 quetschke 2003-04-07 15:20:40 UTC
> As suggested in the tools mailing list, it is probably a better 
> idea to split this windows document into two separate build docs - 
> one for win+4nt and one for win tcsh. At the end of the day, we 
> want to get rid (not support) win+4nt anymore anyway, because 4nt 
> is not free. 
100% agreed.

> about the build_<platform>.html file header remark: 
> I just wanted to avoid people checking in new versions of these 
> files directly but use the template instead. I wanted to avoid 
> that after time the three documents get a different structure. 
> Since the build experience is still more or less the same for 
> all three platforms, the build docs should keep the same, too. 
Yes, issue 13097 already contains a patch for mkbuilddoc and one for
build_template to use linux, solaris, windows and win_tcsh.

> That is all my opinion. What do you think?
It's my opinion too. Go for it!
Comment 23 Martin Hollmichel 2003-04-29 14:27:50 UTC
retargeting
Comment 24 quetschke 2003-05-10 11:34:56 UTC
Everyting is comitted
Comment 25 quetschke 2003-05-10 11:35:25 UTC
close