annotate PROGRAMMING_NOTES @ 9969:cc2e6dd43613

[gaim-migrate @ 10879] (21:35:19) nosnilmot: LSchiere: gaim_blist_add_group() should not really be #if 0'd out... does that need a patch? (21:35:38) LSchiere: why is it #if 0'ed? (21:35:50) nosnilmot: merging error afaict (21:35:52) interalia: datallah: talking to yourself is OK. it's when you answer that it becomes a problem... (21:35:54) LSchiere: i'm assuming it was done for a reason, temporary as that reason might be (21:36:04) nosnilmot: it's not #if 0'd in chip's svn tree (21:36:08) LSchiere: oddness (21:36:16) interalia: cvs annotate to the rescue! (21:36:23) LSchiere: was that part of datallah's patch failure handle patch? (21:36:49) datallah: yeah... i'm confused as to how it happened, but the first part happened during the plain merge and the #endif i added during the .rej cleanup iirc (21:37:31) nosnilmot: yup, datallah's right :) I suspect the #if 0 came in because "patch" was trying to "help" (21:37:47) LSchiere: okay, let's see what happens without that (21:38:11) nosnilmot: "it works a lot better and doesn't eat as many buddy lists for breakfast" (21:38:12) datallah: it definitely needs to not be commented out it compiles uncommented, so we'll go with their opinion committer: Tailor Script <[e-mail]>

Notes on keeping GAIM OS independant
------------------------------------

General
-------
- Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths

- Use g_getenv, g_snprintf, g_vsnprintf

- Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME")

- Make sure when including win32dep.h that it is the last header to
  be included.

- Open binary files when reading or writing with 'b' mode.

  e.g: fopen("somefile", "wb");

  Not doing so will open files in windows using defaut translation mode. 
  i.e. newline -> <CR><LF>

Paths
-----

- DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions.
  Doing the following will therefore break the windows build:

  printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");

  it should be:

  printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");

PLUGINS & PROTOS
----------------

- G_MODULE_EXPORT all functions which are to be accessed from outside the
  scope of its "dll" or "so". (E.G. gaim_plugin_init)

- G_MODULE_IMPORT all global variables which are located outside your
  dynamic library. (E.G. connections)

  (Not doing this will cause "Memory Access Violations" in Win32)