search

openbmc / obmc-console

OpenBMC host console infrastructure
Apache License 2.0
17 stars 25 forks source link

README needed for obmc-console #4

Closed vishwabmc closed 8 years ago

vishwabmc commented 8 years ago

obmc-console is using automake constructs and hence would need a README that will help whoever that makes a change and wants to recompile.

I had made some changes but could not compile it successfully with my SDK environment and I tried couple things like below and they did not compile it good. I then built a complete palmetto image and tested.

msbarth commented 8 years ago

There's actually more required for automake than just README. Automake required files:

I'm not sure if I've captured what was intended initially, but after you created this issue, I followed the steps that came up with on creating initial config,make, etc.. files with autotools and included them in a zip. Please re-attempt after extracting what's provided here within your repo following these steps:

msbarth commented 8 years ago

Looks like I missed the symlinks, here's an updated tar containing what's needed. Please update the following symlinks to point to the appropriate location within your sdk. (Currently using the default automake provided files from within the sdk) autotools_obmc-console.tar.zip

williamspatrick commented 8 years ago

@jk-ozlabs - Do you know how this was set up to allow compiling? There is no instructions.

williamspatrick commented 8 years ago

I was able to build on an x86 system by running just the following:

aclocal && automake --add-missing && autoconf && ./configure

shenki commented 8 years ago

I normally use the following steps to build a project from a git checkout:

autoreconf -i
./configure
make

man autoreconf:

NAME
       autoreconf - Update generated configuration files

SYNOPSIS
       autoreconf [OPTION]... [DIRECTORY]...

DESCRIPTION
       Run  `autoconf'  (and  `autoheader', `aclocal', `automake', `autopoint'
       (formerly `gettextize'), and `libtoolize' where appropriate) repeatedly
       to remake the GNU Build System files in specified DIRECTORIES and their
       subdirectories (defaulting to `.').
williamspatrick commented 8 years ago

@jk-ozlabs is there a recommendation? Should we add the 'correct' way to the README or is it assumed that most people know what they are doing?

vishwabmc commented 8 years ago

@jk-ozlabs I would recommend for a README

williamspatrick commented 8 years ago

@vishwabmc - Since @msbarth is going to be converting all of the repositories over to autotools I'm not sure if it is best for us to put that in the README of each repository or it is something that is assumed to be "generally known about autotools".

shenki commented 8 years ago

Paging @stewart-ibm. He's our autofool

ghost commented 8 years ago

Generally, autoreconf -iis the standard way. That being said, it's also quite common to have an./autogen.shscript in the repo that calls it, and this is from the days before there was justautoreconfand you instead had to doautoconf; automake; aclocal` or whatever you needed.

jk-ozlabs commented 8 years ago

Yep, autoreconf -i is standard. Do we want this in all of the projects' READMEs?

jk-ozlabs commented 8 years ago

(In thinking that we'd have a bit of boilerplate in each readme, with the standard instructions to compile)

williamspatrick commented 8 years ago

@msbarth - I believe you are taking care of this by converting obmc-console to the same autotools structure we have for host-ipmid. Please add 'Resolves openbmc/obmc-console#4.' to your commit message.

msbarth commented 8 years ago

Will do.

Also, from re-configuring often while converting to autotools, I planned to update the autoreconf call to 'autoreconf -if' to ensure its reconfigured each time in case autoreconf generated files already exist.