1 WikiTodo
Rom Walton edited this page 2015-02-04 20:21:23 -05:00

Please describe error and omissions in the BOINC documentation here.

#!comment 
Add new items at the end of the appropriate section. If you don't know what section is best, just add it at the end of the page. Don't delete existing items unless you're marking them as done!

Please keep the bulleted list format. Note that you must have a space before the asterisk.

Missing information (or requests for documentation) #missing

  • Version history information for 6.4.7 is missing.

  • Where is the format of global_prefs.xml? I want to link it from ClientSim#input_sim_prefs. I see many pages with related info, I don't know which one is right or correct: PrefsImpl, GlobalPrefs (doesn't show XML format), PrefsOverride, and bottom of ClientFiles.

    • These pages are updated. Please will someone double-check before removing this and PrefsOverride below?
  • It would be helpful if Upgrade instructions were included, perhaps on the Release Page (where it is suggested that users upgrade to the latest version). Does the previous version have to be uninstalled before upgrading or can the latest version just be copied into the same directory? Or should I put latest version into a new directory? What's the risk to my current projects? (I don't want to lose my Climate Prediction simulation that's been running for past 6 months). Is there any copying of config files, etc? If it doesn't seem to work, can I back it out? Etc.

  • It may be useful to have a new page (MigratingServers) explaining how to migrate a BOINC project to a new server.

  • The information in the Crashes section on ReportBugs is extremely Windows-centric. It would be great to have it expanded for other operating systems.

  • The build instructions for UNIX kind of lack a pointer to all the help that Linux distributions give in this respect. These come with complete build environments and, i.e., Debian provides packages for BOINC's clients and developers experiment for such for servers http://wiki.debian.org/BOINC/Server.

    • I strongly disagree about making a boinc-server package. If setting up a server involves just typing apt-get install boinc-server, [more] people who don't really know what they're doing will do it.
  • In the 'Help' page of the Windows BOINC Version 5.10.20, menu point 'Preferences' there is a field in the windows titled 'Day-of-week Override'. It is not clear to me, if I want to block BOINC activity during my weekly virus scan I have to put in the time of the virus scan or the complement of it. Please could someone add a remark about this option into the BoincWiki help page. i found no entry searching for 'Day-of-week Override'.

  • System requirements for BOINC 6, more specifically which operating systems are minimally required? Can it be run on Windows 98?

  • General system requirements for BOINC screen saver. Minimum/recommended.

  • Attach to project wizard documentation

  • Attach to account manager wizard documentation

  • Incomplete Bolt Attributes and adaptation http://boinc.berkeley.edu/trac/wiki/BoltTutorialAdapt

  • The SecurityIssues page does not address potential vulnerabilities in the BOINC protocol implementations on both the client and server. It would be good to link to the protocol and describe what steps have been taken to ensure the BOINC client/server communication channel is secure from buffer overflows or other attacks that would compromise an endpoint.

  • The BOINC acronym should be defined right up front. There is no way to figure out what it stands for.

Out of date information #out-of-date

  • Implementation notes are most very outdated.
  • DebugClientWin is mostly obsoleted by the built-in debug dump.
  • SecurityIssues should be checked when 6.0 is out and about. Certainly the part on sandboxing.
  • ClientApp and CompileClient point to Visual C++ 2005 Express Edition. The new links point exclusively to the 2008 version. Has anyone tested building BOINC or apps with the 2008 version?
    • Having burned Visual Studio 2008 Express Edition to DVD I found it cannot be installed on any Windows version below XP. So for compatibility reasons, should we even link to the 2008 version? (I have for now added links pointing back to the correct download page for VS 2005 EE)
  • ReportBugs says bugs should be reported to boinc_alpha. It should mention Trac bug tracker instead.

Minor corrections #minor

  • JobIn needs similar work to BackendState: reformatting using headings instead of that table mess. I reformatted JobIn using definition lists. I think it looks better than with headings, but we can't link to individual attributes...
  • ProfileScreen: The description of Loose screening says: The UOTD is selected randomly from among approved profiles. This is not what uotd.inc does, the default_uotd_candidates_query ignores the verification field.
  • ProjectLaunch: Add a comment for the users not to enable the team_import project task on internal company grids.
  • VolunteerRecruit: The web page ffmail_form.php lets users send emails to their friends.

Misc #misc

  • PythonMysql had been converted from the original .txt. I recently "wikified" the page, since it was just plaintext copied verbatim. It probably needs some cleanup, and checking if the information on it is still correct.
    • Answer: With recent distributions you won't need this page anymore. I always used the stable packages (usually: python-mysqldb) provided by each distro and got no problems. ChristianB
    • Other pages need to be updated to say Python DB can just be installed that way.
  • Would it make sense to move DevProjects stuff into Trac tickets marked as 'Task'?
    • Seconded.
    • This was done.

Pages Tagged for Attention #tags

You can tag pages for further action with the following tags: wiki_todo_', '''wiki_cleanup''', '''wiki_delete''' and '_image_todo.

Pages needing attention (wiki_todo)

[[showheadings=false, tagspace=wiki)](ListTagged(wiki_todo,)]

Pages needing wiki cleanup (wiki_cleanup)

[[showheadings=false, tagspace=wiki)](ListTagged(wiki_cleanup,)]

Pages pending deletion (wiki_delete)

[[showheadings=false, tagspace=wiki)](ListTagged(wiki_delete,)]

Images needing attention (image_todo)

[[showheadings=false, tagspace=wiki)](ListTagged(image_todo,)]

Not the Wiki #not-wiki

** mention that only IPv4 is supported, not yet IPv6 ***

Additional Package needed for Server Install on Linux (SL450)

  • Needed to install freeglut-devel-2.2.0-14.x86_64.rpm to build server on Scientific Linux 4.50, possibly worth adding to 'Software Prerequisits' list.