Bug 193376 - Various documentation updates - some enhancements for 4,0 features and minor fixes from previous releases
Summary: Various documentation updates - some enhancements for 4,0 features and minor ...
Status: RESOLVED FIXED
Alias: None
Product: CDT
Classification: Tools
Component: cdt-doc (show other bugs)
Version: 4.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 4.0   Edit
Assignee: Doug Schaefer CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed
: 71557 (view as bug list)
Depends on:
Blocks:
 
Reported: 2007-06-19 14:39 EDT by Angelina CLA
Modified: 2008-06-20 10:30 EDT (History)
3 users (show)

See Also:


Attachments
Create patch file from Eclipse - for differences (55.32 KB, patch)
2007-06-19 14:41 EDT, Angelina CLA
no flags Details | Diff
Changes made so far (555.91 KB, patch)
2007-06-19 15:16 EDT, Angelina CLA
no flags Details | Diff
Some edits and corrections (15.80 KB, patch)
2007-06-21 12:57 EDT, Angelina CLA
bjorn.freeman-benson: iplog+
Details | Diff
updated copyright graphic (2.91 KB, patch)
2007-06-21 15:31 EDT, Angelina CLA
bjorn.freeman-benson: iplog+
Details | Diff
updated copyright graphics (2.60 KB, patch)
2007-06-21 15:41 EDT, Angelina CLA
bjorn.freeman-benson: iplog+
Details | Diff
Editorial updates and some spell checking (34.86 KB, patch)
2007-06-22 16:47 EDT, Angelina CLA
bjorn.freeman-benson: iplog+
Details | Diff
image updates for June 22 CDT build (911.29 KB, patch)
2007-06-22 17:17 EDT, Angelina CLA
bjorn.freeman-benson: iplog+
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Angelina CLA 2007-06-19 14:39:29 EDT
Build ID: 4.0

Steps To Reproduce:
Just a drop in the bucket. Mainly addressed the Getting started tutorials ans started the "tasks" topics.

A draft version that will be reviewed over the next few days - by Doug. I roushed though some of it and will take some time tonight and tomorrow to review properly. Also to add a bit more "meat and potatoes".



More information:
Comment 1 Angelina CLA 2007-06-19 14:41:38 EDT
Created attachment 71786 [details]
Create patch file from Eclipse - for differences
Comment 2 Angelina CLA 2007-06-19 15:16:05 EDT
Created attachment 71794 [details]
Changes made so far
Comment 3 Doug Schaefer CLA 2007-06-19 15:33:18 EDT
Comment on attachment 71794 [details]
Changes made so far

I have applied this patch. I'd do some further refinement on Wednesday and check that in as well.
Comment 4 Jens Seidel CLA 2007-06-20 04:29:27 EDT
A few remarks to the patch:

Typos (search for it globally, they occur multiple times):
 *dispalys
 *at Step 10instead

Use "into" in "is checked out in to your workspace."?

The text contains stupid Windows paths such as C:\MySrcDirectory (why not
just drop C:/?) and at the same time refers to shared libraries using the
.so suffix (don't they use .dll on windows?)

The paragraph starting with "By default, the indexer is set to <b>Fast indexer</b> for the project" seems wrong to me.
Comment 5 Vivian Kong CLA 2007-06-21 11:07:14 EDT
Hi Angelina,

I've found some errors in the following 2 files that I'm not sure how to fix:

/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm
/org.eclipse.cdt.doc.user/getting_started/cdt_w_newproj.htm

They both have problems with the <fname> tag.  Is that a typo?

Please see the attached "updated error list" in bug 192270 for more details.  Thanks.

Vivian
Comment 6 Vivian Kong CLA 2007-06-21 11:26:09 EDT
Going through the list...here's another file with unknown tags:

/org.eclipse.cdt.doc.user/getting_started/cdt_w_existing_code.htm

Please see the attached "updated error list" in bug 192270 for more details. 

Thanks,
Vivian
Comment 7 Angelina CLA 2007-06-21 11:47:32 EDT
Yes, that's an incorrect tag and I've cleaned it up and will be sending to Doug for updating shortly.
Thanks.
Comment 8 Angelina CLA 2007-06-21 12:57:47 EDT
Created attachment 72063 [details]
Some edits and corrections
Comment 9 Angelina CLA 2007-06-21 15:31:32 EDT
Created attachment 72077 [details]
updated copyright graphic
Comment 10 Angelina CLA 2007-06-21 15:41:32 EDT
Created attachment 72078 [details]
updated copyright graphics
Comment 11 Angelina CLA 2007-06-22 16:47:26 EDT
Created attachment 72218 [details]
Editorial updates and some spell checking
Comment 12 Angelina CLA 2007-06-22 17:17:11 EDT
Created attachment 72226 [details]
image updates for June 22 CDT build
Comment 13 Doug Schaefer CLA 2007-06-22 20:38:57 EDT
Patch applied. Thanks, Angelina!
Comment 14 Doug Schaefer CLA 2007-07-23 10:30:20 EDT
*** Bug 71557 has been marked as a duplicate of this bug. ***
Comment 15 Vivian Kong CLA 2007-08-07 15:51:12 EDT
Hi Angelina,

I got a few questions for the file org.eclipse.cdt.doc.user\getting_started\cdt_w_prepare_workbench.htm

- I had the impression that "Show Line lNumbers" is on the C/C++ > Editor page but that option actually resides in General > Editors > Text Editors. Can the doc be updated and maybe mention that "Show Line Numbers" is in the general editor preference?

- "Problem Indicator Color" does not exist - should this become "Problems" (from the list on the C/C++ > Editor > Syntax Coors page)?

- There is no Colors tab on C/C++ > Editor - can we change it to "Syntax Colors" instead to match the screenshot?

Thanks,
Vivian
Comment 16 Angelina CLA 2007-08-07 15:59:10 EDT
Yes, I'm in the process now of arranging the tabs/windows where they belong. For the previous release, I opened files to make some corrections; no time for rearranging/reorg. But I'm working on that now, and also adding some missing infoas well. Will hav a patch within a week and it will contain a number of updates.