~xrg/openobject-doc/trunk-xrg

.. i18n: On debian, in any distribution, the 1.5 version is working, you can get it on this url: http://backports.org/debian/pool/main/b/bzr/bzr_1.5-1~bpo40+1_i386.deb

214

215

If you don't have at least 1.3 version, you can check this url: http://bazaar-vcs.org/Download

216

On debian, in any distribution, the 1.5 version is working, you can get it on this url: http://backports.org/debian/pool/main/b/bzr/bzr_1.5-1~bpo40+1_i386.deb

217

218

.. i18n: If you experience problems with Bazaar, please read the :ref:`bazaar-faq-link` before asking any questions.

219

220

If you experience problems with Bazaar, please read the :ref:`bazaar-faq-link` before asking any questions.

221

222

.. i18n: Quick Summary

223

.. i18n: +++++++++++++

224

225

Quick Summary

226

+++++++++++++

227

228

.. i18n: .. index::

229

.. i18n: single: Bazaar; summary

230

.. i18n: ..

231

232

.. index::

233

single: Bazaar; summary

234

235

236

.. i18n: This is the official and proposed way to contribute on OpenERP and OpenObject.

237

238

This is the official and proposed way to contribute on OpenERP and OpenObject.

239

240

.. i18n: To download the latest sources and create your own local branches of OpenERP, do this::

241

.. i18n:

242

.. i18n: bzr branch lp:openerp

243

.. i18n: cd openerp

244

.. i18n: ./bzr_set.py

245

246

To download the latest sources and create your own local branches of OpenERP, do this::

247

248

bzr branch lp:openerp

249

cd openerp

250

./bzr_set.py

251

252

.. i18n: This will download all the component of openerp (server, client, addons) and create links of modules in addons in your server so that you can use it directly. You can change the bzr_set.py file to select what you want to download exactly. Now, you can edit the code and commit in your local branch.::

253

.. i18n:

254

.. i18n: EDIT addons/account/account.py

255

.. i18n: cd addons

256

.. i18n: bzr ci -m "Testing Modifications"

257

258

This will download all the component of openerp (server, client, addons) and create links of modules in addons in your server so that you can use it directly. You can change the bzr_set.py file to select what you want to download exactly. Now, you can edit the code and commit in your local branch.::

259

260

EDIT addons/account/account.py

261

cd addons

262

bzr ci -m "Testing Modifications"

263

264

.. i18n: Once your code is good enough and follow the :ref:`coding-guidelines-link`, you

265

.. i18n: can push your branch in launchpad. You may have to create an account on

266

.. i18n: launchpad first, register your public key, and subscribe to the `openerp-community <https://launchpad.net/~openerp-community>`_ team. Then, you

267

.. i18n: can push your branch. Suppose you want to push your addons::

268

.. i18n:

269

.. i18n: cd addons

270

.. i18n: bzr push lp:~openerp-community/openobject-addons/YOURLOGIN_YOURBRANCHNAME

271

.. i18n: bzr bind lp:~openerp-community/openobject-addons/YOURLOGIN_YOURBRANCHNAME

272

273

Once your code is good enough and follow the :ref:`coding-guidelines-link`, you

274

can push your branch in launchpad. You may have to create an account on

275

launchpad first, register your public key, and subscribe to the `openerp-community <https://launchpad.net/~openerp-community>`_ team. Then, you

276

can push your branch. Suppose you want to push your addons::

277

278

cd addons

279

bzr push lp:~openerp-community/openobject-addons/YOURLOGIN_YOURBRANCHNAME

280

bzr bind lp:~openerp-community/openobject-addons/YOURLOGIN_YOURBRANCHNAME

281

282

.. i18n: After having done that, your branch is public on Launchpad, in the `OpenObject

283

.. i18n: project <https://code.launchpad.net/openobject>`_, and commiters can work on

284

.. i18n: it, review it and propose for integration in the official branch. The last line

285

.. i18n: allows you to rebind your branch to the one which is on launchpad, after having

286

.. i18n: done this, your commit will be applied on launchpad directly (unless you use ``--local``)::

287

.. i18n:

288

.. i18n: bzr pull # Get modifications on your branch from others

289

.. i18n: EDIT STUFF

290

.. i18n: bzr ci # commit your changes on your public branch

291

292

After having done that, your branch is public on Launchpad, in the `OpenObject

293

project <https://code.launchpad.net/openobject>`_, and commiters can work on

294

it, review it and propose for integration in the official branch. The last line

295

allows you to rebind your branch to the one which is on launchpad, after having

296

done this, your commit will be applied on launchpad directly (unless you use ``--local``)::

297

298

bzr pull # Get modifications on your branch from others

299

EDIT STUFF

300

bzr ci # commit your changes on your public branch

301

302

.. i18n: If your changes fixe a public bug on launchpad, you can use this to mark the bug as fixed by your branch::

303

.. i18n:

304

.. i18n: bzr ci --fixes=lp:453123 # Where 453123 is a bug ID

305

306

If your changes fixe a public bug on launchpad, you can use this to mark the bug as fixed by your branch::

307

308

bzr ci --fixes=lp:453123 # Where 453123 is a bug ID

309

310

.. i18n: Once your branch is mature, mark it as mature in the web interface of launchpad

311

.. i18n: and request for merging in the official release. Your branch will be reviewed

312

.. i18n: by a commiter and then the quality team to be merged in the official release.

313

314

Once your branch is mature, mark it as mature in the web interface of launchpad

315

and request for merging in the official release. Your branch will be reviewed

316

by a commiter and then the quality team to be merged in the official release.

317

318

.. i18n: .. _how-to-get-the-latest-trunk-source-code-link:

319

.. i18n:

320

.. i18n: How to get the latest trunk source code

321

.. i18n: +++++++++++++++++++++++++++++++++++++++

322

323

.. _how-to-get-the-latest-trunk-source-code-link:

324

325

How to get the latest trunk source code

326

+++++++++++++++++++++++++++++++++++++++

327

328

.. i18n: Get a clone of each repository::

329

.. i18n:

330

.. i18n: bzr clone lp:~openerp/openobject-server/trunk server

331

.. i18n: bzr clone lp:~openerp/openobject-client/trunk client

332

.. i18n: bzr clone lp:~openerp/openobject-client-web/trunk client-web

333

.. i18n: bzr clone lp:~openerp/openobject-addons/trunk addons

334

335

Get a clone of each repository::

336

337

bzr clone lp:~openerp/openobject-server/trunk server

338

bzr clone lp:~openerp/openobject-client/trunk client

339

bzr clone lp:~openerp/openobject-client-web/trunk client-web

340

bzr clone lp:~openerp/openobject-addons/trunk addons

341

342

.. i18n: If you want to get a clone of the extra-addons repository, you can execute this command::

343

.. i18n:

344

.. i18n: bzr clone lp:~openerp-commiter/openobject-addons/trunk-extra-addons extra-addons

345

346

If you want to get a clone of the extra-addons repository, you can execute this command::

347

348

bzr clone lp:~openerp-commiter/openobject-addons/trunk-extra-addons extra-addons

349

350

.. i18n: run the setup scripts in the respective directories::

351

.. i18n:

352

.. i18n: python2.4 setup.py build

353

.. i18n: python2.4 setup.py install

354

355

run the setup scripts in the respective directories::

356

357

python2.4 setup.py build

358

python2.4 setup.py install

359

360

.. i18n: Currently the initialisation procedure of the server parameter --init=all to

361

.. i18n: populate the database seems to be broken in trunk.

362

363

Currently the initialisation procedure of the server parameter --init=all to

364

populate the database seems to be broken in trunk.

365

366

.. i18n: It is recommended to create a new database via the gtk-client. Before that the web-client will not work.

367

368

It is recommended to create a new database via the gtk-client. Before that the web-client will not work.

369

370

.. i18n: Start OpenERP server like this: ::

371

.. i18n:

372

.. i18n: ./openerp-server.py --addons-path=/path/to/my/addons

373

374

Start OpenERP server like this: ::

375

376

./openerp-server.py --addons-path=/path/to/my/addons

377

378

.. i18n: The ``bin/addons`` will be considered as default addons directory which can be

379

.. i18n: overriden by the ``/path/to/my/addons/``. That is if an addon exists in

380

.. i18n: ``bin/addons`` as well as ``/path/to/my/addons`` (custom path) the later one will

381

.. i18n: be given preference over the ``bin/addons`` (default path).

382

383

The ``bin/addons`` will be considered as default addons directory which can be

384

overriden by the ``/path/to/my/addons/``. That is if an addon exists in

385

``bin/addons`` as well as ``/path/to/my/addons`` (custom path) the later one will

386

be given preference over the ``bin/addons`` (default path).

387

388

.. i18n: How to commit Your Work

389

.. i18n: +++++++++++++++++++++++

390

391

How to commit Your Work

392

+++++++++++++++++++++++

393

394

.. i18n: If you want to contribute on OpenERP or OpenObject, here is the proposed method:

395

396

If you want to contribute on OpenERP or OpenObject, here is the proposed method:

397

398

.. i18n: * You create a branch on launchpad on the project that interest you. It's

399

.. i18n: important that you create your branch on launchpad and not on your local

400

.. i18n: system so that we can easily merge, share code between projects and

401

.. i18n: centralize futur developments.

402

.. i18n: * You develop your own features or bugfixes

403

.. i18n: in your own branch on launchpad. Don't forget to set the status of your

404

.. i18n: branch (new, experimental, development, mature, ...) so that contributors

405

.. i18n: knows what they can use or not.

406

.. i18n: * Once your code is good enough, you propose your branch for merging

407

.. i18n: * Your work will be evaluated by one responsible of the commiters team.

408

.. i18n:

409

.. i18n: - If they accept your branch for integration in the official version, they

410

.. i18n: will submit to the quality team that will review and merge in the official

411

.. i18n: branch.

412

.. i18n: - If the commiter team refuses your branch, they will explain why

413

.. i18n: so that you can review your code to better fits guidelines (problem for

414

.. i18n: futur migrations, ...)

415

416

* You create a branch on launchpad on the project that interest you. It's

417

important that you create your branch on launchpad and not on your local

418

system so that we can easily merge, share code between projects and

419

centralize futur developments.

420

* You develop your own features or bugfixes

421

in your own branch on launchpad. Don't forget to set the status of your

422

branch (new, experimental, development, mature, ...) so that contributors

423

knows what they can use or not.

424

* Once your code is good enough, you propose your branch for merging

425

* Your work will be evaluated by one responsible of the commiters team.

426

427

- If they accept your branch for integration in the official version, they

428

will submit to the quality team that will review and merge in the official

429

branch.

430

- If the commiter team refuses your branch, they will explain why

431

so that you can review your code to better fits guidelines (problem for

432

futur migrations, ...)

433

434

.. i18n: The `extra-addons branch <https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-extra-addons>`_,

435

.. i18n: that stores all extra modules, is directly accessible to all commiters. If you

436

.. i18n: are a commiter, you can work directly on this branch and commit your own work.

437

.. i18n: This branch do not require a validation of the quality team. You should put

438

.. i18n: there your special modules for your own customers.

439

440

The `extra-addons branch <https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-extra-addons>`_,

441

that stores all extra modules, is directly accessible to all commiters. If you

442

are a commiter, you can work directly on this branch and commit your own work.

443

This branch do not require a validation of the quality team. You should put

444

there your special modules for your own customers.

445

446

.. i18n: If you want to propose or develop new modules, we suggest you to create your

447

.. i18n: own branch in the `openobject-addons project <https://launchpad.net/openobject-addons>`_

448

.. i18n: and develop within your branch. You can fill in a bug to request that

449

.. i18n: your modules are integrated in one of the two branches:

450

451

If you want to propose or develop new modules, we suggest you to create your

452

own branch in the `openobject-addons project <https://launchpad.net/openobject-addons>`_

453

and develop within your branch. You can fill in a bug to request that

454

your modules are integrated in one of the two branches:

455

456

.. i18n: * `extra-addons branch <https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-extra-addons>`_ : if your module touches a few companies

457

.. i18n: * `addons <https://code.launchpad.net/~openerp/openobject-addons/trunk>`_ : if your module will be usefull for most of the companies

458

459

* `extra-addons branch <https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-extra-addons>`_ : if your module touches a few companies

460

* `addons <https://code.launchpad.net/~openerp/openobject-addons/trunk>`_ : if your module will be usefull for most of the companies

461

462

.. i18n: We invite all our partners and contributors to work in that way so that we can

463

.. i18n: easily integrate and share the work done between the different projects.

464

465

We invite all our partners and contributors to work in that way so that we can

466

easily integrate and share the work done between the different projects.

467

468

.. i18n: Use Case Developpers

469

.. i18n: ++++++++++++++++++++

470

471

Use Case Developpers

472

++++++++++++++++++++

473

474

.. i18n: This page present the approach your should follow on how to contribute in

475

.. i18n: OpenObject. Suppose you want to develop new features in the addons or simply

476

.. i18n: correct some bugfixes.

477

478

This page present the approach your should follow on how to contribute in

479

OpenObject. Suppose you want to develop new features in the addons or simply

480

correct some bugfixes.

481

482

.. i18n: If you have the right to modify directly the branch you plan to change, you can

483

.. i18n: do it directly. For example, a quality team member doing a bugfix can do it

484

.. i18n: directly on the main branch. Or commiters can work directly on the

485

.. i18n: extra-addons. If you don't have the right to modify the branch you plan to

486

.. i18n: change or if you want to branch because you are starting big developments

487

.. i18n: that may break the code, the first thing to do is to branch the repository

488

.. i18n: you plan to modify::

489

.. i18n:

490

.. i18n: bzr branch lp:openobject-addons lp:~openerp-commiter/openobject-addons/trunk-new-reporting

491

492

If you have the right to modify directly the branch you plan to change, you can

493

do it directly. For example, a quality team member doing a bugfix can do it

494

directly on the main branch. Or commiters can work directly on the

495

extra-addons. If you don't have the right to modify the branch you plan to

496

change or if you want to branch because you are starting big developments

497

that may break the code, the first thing to do is to branch the repository

498

you plan to modify::

499

500

bzr branch lp:openobject-addons lp:~openerp-commiter/openobject-addons/trunk-new-reporting

501

502

.. i18n: In that case, the branch created will be for the openerp-commiter team. If you

503

.. i18n: are not a commiter, you can create the branch for the community team

504

.. i18n: openerp-community or just for youself, depending if you accept people to

505

.. i18n: directly commit on your branch or not. For all Tiny employees, we propose to

506

.. i18n: create all branches for the team openerp-commiter. An OpenERP service company

507

.. i18n: may create a team for their company and create branches at the name of their

508

.. i18n: team. This will allow them to avoid others people that will change their

509

.. i18n: customer branch.

510

511

In that case, the branch created will be for the openerp-commiter team. If you

512

are not a commiter, you can create the branch for the community team

513

openerp-community or just for youself, depending if you accept people to

514

directly commit on your branch or not. For all Tiny employees, we propose to

515

create all branches for the team openerp-commiter. An OpenERP service company

516

may create a team for their company and create branches at the name of their

517

team. This will allow them to avoid others people that will change their

518

customer branch.

519

520

.. i18n: Once the branch is created, you must checkout a local copy to work on::

521

.. i18n:

522

.. i18n: bzr co lp:~openerp-commiter/openobject-addons/trunk-new-reporting

523

524

Once the branch is created, you must checkout a local copy to work on::

525

526

bzr co lp:~openerp-commiter/openobject-addons/trunk-new-reporting

527

528

.. i18n: This will download the branch on your local computer. You can then start

529

.. i18n: developing on it. From time to time, you should commit the work done::

530

.. i18n:

531

.. i18n: bzr ci

532

533

This will download the branch on your local computer. You can then start

534

developing on it. From time to time, you should commit the work done::

535

536

bzr ci

537

538

.. i18n: This will send your modification to the branch:

539

.. i18n: lp:~openerp-commiter/openobject-addons/trunk-new-reporting. Don't forget to

540

.. i18n: change the status of the branch to show others contributors the status of your

541

.. i18n: current work on

542

.. i18n: https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-new-reporting

543

544

This will send your modification to the branch:

545

lp:~openerp-commiter/openobject-addons/trunk-new-reporting. Don't forget to

546

change the status of the branch to show others contributors the status of your

547

current work on

548

https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-new-reporting

549

550

.. i18n: For instance, you can switch the status to "In Development" to show you are

551

.. i18n: working on it and put the status to "Mature" when you'd like to have your code

552

.. i18n: integrated in the official release.

553

554

For instance, you can switch the status to "In Development" to show you are

555

working on it and put the status to "Mature" when you'd like to have your code

556

integrated in the official release.

557

558

.. i18n: During your development, if you want to receive the latests modifications from

559

.. i18n: the parent branches, you can merge it::

560

.. i18n:

561

.. i18n: bzr merge

562

563

During your development, if you want to receive the latests modifications from

564

the parent branches, you can merge it::

565

566

bzr merge

567

568

.. i18n: Once your development on this branch are ok, you can ask a commiter to review

569

.. i18n: and merge it or fill in a bug in the bugtracker. A commiter will then review

570

.. i18n: your work and merge it to the official branch if it's good enough.

571

572

Once your development on this branch are ok, you can ask a commiter to review

573

and merge it or fill in a bug in the bugtracker. A commiter will then review

574

your work and merge it to the official branch if it's good enough.

Older »