glusterfs.git/doc, branch v6dev

clang-format: add the config file

2018-09-12T11:48:34+00:00

Also update the required documents and scripts to enable clang-format

Change-Id: I73aae6db06c2f732a1779d59a73bc05e28beafba
updates: bz#1564149
Signed-off-by: Amar Tumballi

doc: make developer-index.md as README

2018-09-12T09:28:49+00:00

This helps to traverse the docs well as README.md is rendered
by default in github pages, and would help to provide better indexed
document for new users.

updates: bz#1193929
Change-Id: I4130dfd16aed924ecab17f96326cedb86892d6a6
Signed-off-by: Amar Tumballi

doc: add coding-standard and commit-msg link in README

2018-09-11T22:55:23+00:00

Having the links in README makes people follow it if they browse
through github.

Updates: bz#1193929
Change-Id: I580332a41d9b52858aa9796a74a563ff57a60b4b
Signed-off-by: Amar Tumballi

doc: add details on how the commit should be structured

2018-09-10T18:49:54+00:00

Detailing how the commit message should be is very important for imposing
some structure, and good practises. Also it helps new developers to do the
right things.

This is mostly copied from the OpenStack commit message reference, as it
was overlapping with most of the things we follow in GlusterFS. Made
minor changes to make it suitable for Gluster project.

Updates: bz#1193929
Change-Id: I4dcd7ff366edfc6c1727a287f32bcf7270c86b11
Signed-off-by: Amar Tumballi

classification: provide infra to start labelling features/components

2018-09-04T09:15:49+00:00

`doc/xlator-classification.md` talks about the reasoning and expectations

Reviewers are expected to check the 'category' of new
option / translator added in the codebase, and make sure the flag
is always properly set. It helps to keep the 'expectation' proper
on the codebase.

updates: #430
Change-Id: I2bfc9934a5f6eed77fcc3e20364046242decc82c
Signed-off-by: Amar Tumballi

doc: Add details around xlator categories

2018-08-17T07:50:12+00:00

Updates: bz#1193929
Change-Id: I6446bbdd8025f333a3e855032c0c7709bf4ae4cd
Signed-off-by: ShyamsundarR

glusterd: fix gcc7 warnings

2018-08-14T15:35:21+00:00

    [sh]$ gcc --version
    gcc (GCC) 7.3.1 20180303 (Red Hat 7.3.1-5)

Warnings were of the type below:

xlators/mgmt/glusterd/src/glusterd-store.c:3285:33:
warning: ‘/options’ directive output may be truncated writing 8 bytes into a region of size between 1 and 4096 [-Wformat-truncation=]
         snprintf (path, len, "%s/options", conf->workdir);
                                 ^~~~~~~~
xlators/mgmt/glusterd/src/glusterd-store.c:1280:39:
warning: ‘/snaps/’ directive output may be truncated writing 7 bytes into a region of size between 1 and 4096 [-Wformat-truncation=]
         snprintf (snap_fpath, len, "%s/snaps/%s/%s", priv->workdir,
                                       ^~~~~~~

* Also changed some places where there was issues with key size
* Made sure all the 'char buf[SOMESIZE] = {0,};' are changed to 'char buf[SOMESIZE] = "";`
  - In the files I changed

* Also edited coding standard to reflect that.

updates: bz#1193929
Change-Id: I04c652624ac63199cea2077e46b3a5def37c3689
Signed-off-by: Amar Tumballi

coding-standard: add points on structure padding

2018-08-02T05:14:32+00:00

This is a recommendation for users, and reviewers can take a point from this.

Updates: bz#1193929
Change-Id: Idcd778e42a886fd79b549da4927149a07573a20b
Signed-off-by: Amar Tumballi

doc: keep just one copy of a coredump analysis

2018-08-01T18:41:21+00:00

Keeping two copies of the files means, one would be out-of-date soon,
and users would always be confused about which one is the source of
truth.

Updates: bz#1193929
Change-Id: I568149732fdb9d282ccd583640eee9b9056963fd
Signed-off-by: Amar Tumballi

feature/cloudsync: Dev guide to write a Cloudsync Plugin

2018-05-30T03:25:59+00:00

Updates: #387
Change-Id: I50ef84e5e67a648384394dfad003884d25a4c746
Signed-off-by: Susant Palai